ingewortel/artistoo Artistoo

CPM implementation in pure javascript (Node module)

#33 (all)
JavaScript (change)
24 seconds
5 days ago

This page shows an evaluation of the project's documentation.

Each class, module, method, etc. is given a grade based on how complete the docs are.

The bar above shows the distribution of these grades.

JavaScript support is still young. Please report any mistakes Inch makes!
Seems really good
A
SoftConnectivityConstraint#postSetpixListener in /src/hamiltonian/SoftConnectivityConstraint.js Ne
A
ConnectivityConstraint#postSetpixListener in /src/hamiltonian/ConnectivityConstraint.js Ne
A
ActivityConstraint#postSetpixListener in /src/hamiltonian/ActivityConstraint.js Ne
A
PersistenceConstraint#setDirection in /src/hamiltonian/PersistenceConstraint.js Ne
A
GridBasedModel#setpixi in /src/models/GridBasedModel.js Ne
A
GridBasedModel#setpix in /src/models/GridBasedModel.js Ne
A
CPM#setCellKind in /src/models/CPM.js Ne
A
Grid#setpixi in /src/grid/Grid.js Ne
A
CPM#setpixi in /src/models/CPM.js Ne
A
Grid#setpix in /src/grid/Grid.js Ne
A
Adhesion#H in /src/hamiltonian/Adhesion.js Ne
A
Adhesion#J in /src/hamiltonian/Adhesion.js Ne
A
ParameterChecker#confCheckStructureKindMatrix in /src/hamiltonian/ParameterChecker.js E
A
ParameterChecker#confCheckStructureKindArray in /src/hamiltonian/ParameterChecker.js E
A
ParameterChecker#confCheckStructureSingle in /src/hamiltonian/ParameterChecker.js E
A
ParameterChecker#confCheckStructure in /src/hamiltonian/ParameterChecker.js E
A
GridManipulator#seedCellsInCircle in /src/grid/GridManipulator.js E
A
ParameterChecker#isNonNegative in /src/hamiltonian/ParameterChecker.js E
A
ParameterChecker#isProbability in /src/hamiltonian/ParameterChecker.js E
A
ParameterChecker#isCoordinate in /src/hamiltonian/ParameterChecker.js E
A
ParameterChecker#isBoolean in /src/hamiltonian/ParameterChecker.js E
A
GridManipulator#seedCellAt in /src/grid/GridManipulator.js E
A
ParameterChecker#isNumber in /src/hamiltonian/ParameterChecker.js E
A
GridBasedModel#getStat in /src/models/GridBasedModel.js E
A
Grid3D#i2p in /src/grid/Grid3D.js E
A
Grid3D#p2i in /src/grid/Grid3D.js E
A
Grid2D#i2p in /src/grid/Grid2D.js E
A
Grid2D#p2i in /src/grid/Grid2D.js E
A
ParameterChecker#isString in /src/hamiltonian/ParameterChecker.js E
A
SoftConnectivityConstraint#updateBorderPixels in /src/hamiltonian/SoftConnectivityConstraint.js E
A
ConnectivityConstraint#updateBorderPixels in /src/hamiltonian/ConnectivityConstraint.js E
A
PerimeterConstraint#postSetpixListener in /src/hamiltonian/PerimeterConstraint.js E
A
ParameterChecker#confCheckValueType in /src/hamiltonian/ParameterChecker.js E
A
ActivityConstraint#activityAtArith in /src/hamiltonian/ActivityConstraint.js E
A
ActivityConstraint#activityAtGeom in /src/hamiltonian/ActivityConstraint.js E
A
PersistenceConstraint#normalize in /src/hamiltonian/PersistenceConstraint.js E
A
VolumeConstraint#volconstraint in /src/hamiltonian/VolumeConstraint.js E
A
ActivityConstraint#pxact in /src/hamiltonian/ActivityConstraint.js E
A
GridBasedModel#cellKind in /src/models/GridBasedModel.js E
A
CPM#updateborderneari in /src/models/CPM.js E
A
Grid#correctPosition in /src/grid/Grid.js E
A
CoarseGrid#addValue in /src/grid/CoarseGrid.js E
A
GridBasedModel#pixt in /src/models/GridBasedModel.js E
A
CPMEvol#cellDeath in /src/models/CPMEvol.js E
A
Grid#applyLocally in /src/grid/Grid.js E
A
Grid#checkOnGrid in /src/grid/Grid.js E
A
Grid2D#gradienti in /src/grid/Grid2D.js E
A
DiceSet#contains in /src/DiceSet.js E
A
CPMEvol#getCell in /src/models/CPMEvol.js E
A
CoarseGrid#pixt in /src/grid/CoarseGrid.js E
A
Grid#multiplyBy in /src/grid/Grid.js E
A
Grid#laplaciani in /src/grid/Grid.js E
A
Grid#gradienti in /src/grid/Grid.js E
A
Grid#diffusion in /src/grid/Grid.js E
A
DiceSet#remove in /src/DiceSet.js E
A
DiceSet#insert in /src/DiceSet.js E
A
Grid#laplacian in /src/grid/Grid.js E
A
CPM#getVolume in /src/models/CPM.js E
A
Grid#gradient in /src/grid/Grid.js E
A
CPM#cellKind in /src/models/CPM.js E
A
Grid#neighi in /src/grid/Grid.js E
A
Grid#pixti in /src/grid/Grid.js E
A
Grid#neigh in /src/grid/Grid.js E
A
Grid#pixt in /src/grid/Grid.js E
A
Grid#p2i in /src/grid/Grid.js E
A
Grid#i2p in /src/grid/Grid.js E
A
CPM#pixt in /src/models/CPM.js E
A
CPM#add in /src/models/CPM.js E
A
GridBasedModel#neigh in /src/models/GridBasedModel.js E
A
Grid2D#neighNeumanni in /src/grid/Grid2D.js E
A
Grid#neighNeumanni in /src/grid/Grid.js E
A
Grid3D#neighi in /src/grid/Grid3D.js E
A
Grid2D#neighi in /src/grid/Grid2D.js E
A
ParameterChecker#confCheckPresenceOf in /src/hamiltonian/ParameterChecker.js E
A
GridManipulator#divideCell in /src/grid/GridManipulator.js E
A
Canvas#drawCells in /src/Canvas.js E
A
Grid3D#pixelsi in /src/grid/Grid3D.js E
A
Grid2D#pixelsi in /src/grid/Grid2D.js E
A
Grid3D#pixels in /src/grid/Grid3D.js E
A
Grid2D#pixels in /src/grid/Grid2D.js E
A
ParameterChecker#confCheckParameter in /src/hamiltonian/ParameterChecker.js E
A
GridManipulator#assignCellPixels in /src/grid/GridManipulator.js E
A
GridManipulator#makeCircle in /src/grid/GridManipulator.js E
A
GridManipulator#makeLine in /src/grid/GridManipulator.js E
A
GridManipulator#makeBox in /src/grid/GridManipulator.js E
A
ConnectedComponentsByCellBorder#connectedComponentsOfCellBorder in /src/stats/ConnectedComponentsByCellBorder.js E
A
SoftConnectivityConstraint#connectedComponentsOfCellBorder in /src/hamiltonian/SoftConnectivityConstraint.js E
A
ConnectivityConstraint#connectedComponentsOfCellBorder in /src/hamiltonian/ConnectivityConstraint.js E
A
SoftLocalConnectivityConstraint#connectedComponentsOf in /src/hamiltonian/SoftLocalConnectivityConstraint.js E
A
ConnectedComponentsByCell#connectedComponentsOfCell in /src/stats/ConnectedComponentsByCell.js E
A
CentroidsWithTorusCorrection#computeCentroidOfCell in /src/stats/CentroidsWithTorusCorrection.js E
A
LocalConnectivityConstraint#connectedComponentsOf in /src/hamiltonian/LocalConnectivityConstraint.js E
A
SoftConnectivityConstraint#connectedComponentsOf in /src/hamiltonian/SoftConnectivityConstraint.js E
A
SoftLocalConnectivityConstraint#checkConnected in /src/hamiltonian/SoftLocalConnectivityConstraint.js E
A
ConnectivityConstraint#connectedComponentsOf in /src/hamiltonian/ConnectivityConstraint.js E
A
SoftLocalConnectivityConstraint#confChecker in /src/hamiltonian/SoftLocalConnectivityConstraint.js E
A
ActivityMultiBackground#setBackgroundVoxels in /src/hamiltonian/ActivityMultiBackground.js E
A
LocalConnectivityConstraint#checkConnected in /src/hamiltonian/LocalConnectivityConstraint.js E
A
SoftConnectivityConstraint#checkConnected in /src/hamiltonian/SoftConnectivityConstraint.js E
A
SoftConnectivityConstraint#localConnected in /src/hamiltonian/SoftConnectivityConstraint.js E
A
PreferredDirectionConstraint#confChecker in /src/hamiltonian/PreferredDirectionConstraint.js E
A
PerimeterConstraint#initializePerimeters in /src/hamiltonian/PerimeterConstraint.js E
A
SoftConnectivityConstraint#connectivity in /src/hamiltonian/SoftConnectivityConstraint.js E
A
ConnectedComponentsByCellBorder#compute in /src/stats/ConnectedComponentsByCellBorder.js E
A
LocalConnectivityConstraint#confChecker in /src/hamiltonian/LocalConnectivityConstraint.js E
A
SoftConnectivityConstraint#confChecker in /src/hamiltonian/SoftConnectivityConstraint.js E
A
SoftLocalConnectivityConstraint#deltaH in /src/hamiltonian/SoftLocalConnectivityConstraint.js E
A
ConnectivityConstraint#localConnected in /src/hamiltonian/ConnectivityConstraint.js E
A
PersistenceConstraint#postMCSListener in /src/hamiltonian/PersistenceConstraint.js E
A
ConnectivityConstraint#checkConnected in /src/hamiltonian/ConnectivityConstraint.js E
A
AttractionPointConstraint#confChecker in /src/hamiltonian/AttractionPointConstraint.js E
A
LocalConnectivityConstraint#fulfilled in /src/hamiltonian/LocalConnectivityConstraint.js E
A
HardVolumeRangeConstraint#confChecker in /src/hamiltonian/HardVolumeRangeConstraint.js E
A
CentroidsWithTorusCorrection#compute in /src/stats/CentroidsWithTorusCorrection.js E
A
ParameterChecker#confCheckCellKinds in /src/hamiltonian/ParameterChecker.js E
A
CellNeighborList#getNeighborsOfCell in /src/stats/CellNeighborList.js E
A
HardVolumeRangeConstraint#fulfilled in /src/hamiltonian/HardVolumeRangeConstraint.js E
A
ActivityMultiBackground#confChecker in /src/hamiltonian/ActivityMultiBackground.js E
A
PreferredDirectionConstraint#deltaH in /src/hamiltonian/PreferredDirectionConstraint.js E
A
ActivityConstraint#postMCSListener in /src/hamiltonian/ActivityConstraint.js E
A
ConnectivityConstraint#confChecker in /src/hamiltonian/ConnectivityConstraint.js E
A
ConnectedComponentsByCell#compute in /src/stats/ConnectedComponentsByCell.js E
A
ChemotaxisConstraint#deltaHCoarse in /src/hamiltonian/ChemotaxisConstraint.js E
A
PersistenceConstraint#confChecker in /src/hamiltonian/PersistenceConstraint.js E
A
BorderConstraint#setBarrierVoxels in /src/hamiltonian/BorderConstraint.js E
A
SoftConnectivityConstraint#deltaH in /src/hamiltonian/SoftConnectivityConstraint.js E
A
ConnectivityConstraint#fulfilled in /src/hamiltonian/ConnectivityConstraint.js E
A
ChemotaxisConstraint#confChecker in /src/hamiltonian/ChemotaxisConstraint.js E
A
AttractionPointConstraint#deltaH in /src/hamiltonian/AttractionPointConstraint.js E
A
PerimeterConstraint#confChecker in /src/hamiltonian/PerimeterConstraint.js E
A
Centroids#computeCentroidOfCell in /src/stats/Centroids.js E
A
ChemotaxisConstraint#checkField in /src/hamiltonian/ChemotaxisConstraint.js E
A
ActivityMultiBackground#deltaH in /src/hamiltonian/ActivityMultiBackground.js E
A
ActivityConstraint#confChecker in /src/hamiltonian/ActivityConstraint.js E
A
ArtistooWriter#setModelConfig in /src/converter/ArtistooWriter.js E
A
Simulation#addGridManipulator in /src/simulation/Simulation.js E
A
BarrierConstraint#confChecker in /src/hamiltonian/BarrierConstraint.js E
A
BorderConstraint#confChecker in /src/hamiltonian/BorderConstraint.js E
A
VolumeConstraint#confChecker in /src/hamiltonian/VolumeConstraint.js E
A
PersistenceConstraint#deltaH in /src/hamiltonian/PersistenceConstraint.js E
A
BarrierConstraint#fulfilled in /src/hamiltonian/BarrierConstraint.js E
A
ChemotaxisConstraint#deltaH in /src/hamiltonian/ChemotaxisConstraint.js E
A
Simulation#postMCSListener in /src/simulation/Simulation.js E
A
PerimeterConstraint#deltaH in /src/hamiltonian/PerimeterConstraint.js E
A
CPM#cellBorderPixelIndices in /src/models/CPM.js E
A
BorderPixelsByCell#compute in /src/stats/BorderPixelsByCell.js E
A
BorderConstraint#fulfilled in /src/hamiltonian/BorderConstraint.js E
A
Simulation#addConstraints in /src/simulation/Simulation.js E
A
ActivityConstraint#deltaH in /src/hamiltonian/ActivityConstraint.js E
A
Simulation#initializeGrid in /src/simulation/Simulation.js E
A
Simulation#toggleRunning in /src/simulation/Simulation.js E
A
GridManipulator#seedCell in /src/grid/GridManipulator.js E
A
Canvas#drawOnCellBorders in /src/Canvas.js E
A
HardConstraint#fulfilled in /src/hamiltonian/HardConstraint.js E
A
Simulation#createOutputs in /src/simulation/Simulation.js E
A
Constraint#cellParameter in /src/hamiltonian/Constraint.js E
A
CellNeighborList#compute in /src/stats/CellNeighborList.js E
A
VolumeConstraint#deltaH in /src/hamiltonian/VolumeConstraint.js E
A
GridBasedModel#timeStep in /src/models/GridBasedModel.js E
A
GridBasedModel#cellIDs in /src/models/GridBasedModel.js E
A
Constraint#confChecker in /src/hamiltonian/Constraint.js E
A
Constraint#paramOfCell in /src/hamiltonian/Constraint.js E
A
Constraint#paramOfKind in /src/hamiltonian/Constraint.js E
A
Simulation#drawCanvas in /src/simulation/Simulation.js E
A
CPMEvol#makeNewCellID in /src/models/CPMEvol.js E
A
Connectedness#compute in /src/stats/Connectedness.js E
A
SoftConstraint#deltaH in /src/hamiltonian/SoftConstraint.js E
A
GridBasedModel#random in /src/models/GridBasedModel.js E
A
Simulation#addCanvas in /src/simulation/Simulation.js E
A
Simulation#drawOnTop in /src/simulation/Simulation.js E
A
Simulation#drawBelow in /src/simulation/Simulation.js E
A
PixelsByCell#compute in /src/stats/PixelsByCell.js E
A
Canvas#drawCellsOfId in /src/Canvas.js E
A
Simulation#runBurnin in /src/simulation/Simulation.js E
A
Adhesion#confChecker in /src/hamiltonian/Adhesion.js E
A
CPM#cellBorderPixels in /src/models/CPM.js E
A
Canvas#drawPixelSet in /src/Canvas.js E
A
Simulation#logStats in /src/simulation/Simulation.js E
A
GridBasedModel#ran in /src/models/GridBasedModel.js E
A
Canvas#setCanvasId in /src/Canvas.js E
A
CPM#monteCarloStep in /src/models/CPM.js E
A
Centroids#compute in /src/stats/Centroids.js E
A
CPM#makeNewCellID in /src/models/CPM.js E
A
Grid#pixelsBuffer in /src/grid/Grid.js E
A
Adhesion#deltaH in /src/hamiltonian/Adhesion.js E
A
Simulation#step in /src/simulation/Simulation.js E
A
Canvas#writePNG in /src/Canvas.js E
A
Canvas#context in /src/Canvas.js E
A
DiceSet#sample in /src/DiceSet.js E
A
Simulation#run in /src/simulation/Simulation.js E
A
CPM#cellPixels in /src/models/CPM.js E
A
Divider#birth in /src/cells/Divider.js E
A
CPMEvol#birth in /src/models/CPMEvol.js E
A
CPMEvol#reset in /src/models/CPMEvol.js E
A
Stat#compute in /src/stats/Stat.js E
A
CPM#timeStep in /src/models/CPM.js E
A
Grid#pixelsi in /src/grid/Grid.js E
A
CA#timeStep in /src/models/CA.js E
A
Grid#pixels in /src/grid/Grid.js E
A
Cell#birth in /src/cells/Cell.js E
A
CPM#deltaH in /src/models/CPM.js E
A
CPM#docopy in /src/models/CPM.js E
A
CPM#reset in /src/models/CPM.js E
A
GridManipulator#makePlane in /src/grid/GridManipulator.js E
A
Canvas#drawCellBorders in /src/Canvas.js E
A
CPM#getConstraint in /src/models/CPM.js E
Proper documentation present
B
Canvas#drawActivityValues in /src/Canvas.js E
B
PersistenceConstraint#sampleNorm in /src/hamiltonian/PersistenceConstraint.js E
B
PersistenceConstraint#randDir in /src/hamiltonian/PersistenceConstraint.js E
B
Canvas#drawFieldContour in /src/Canvas.js E
B
Canvas#drawField in /src/Canvas.js E
Show 4 more ...
Please take a look
Undocumented
U
MorpheusImport#setPreferredDirectionConstraintForKind in /src/converter/MorpheusImport.js E
U
MorpheusImport#setConnectivityConstraintForKind in /src/converter/MorpheusImport.js E
U
MorpheusImport#setPersistenceConstraintForKind in /src/converter/MorpheusImport.js E
U
MorpheusWriter#setPreferredDirectionConstraint in /src/converter/MorpheusWriter.js E
U
MorpheusImport#setPerimeterConstraintForKind in /src/converter/MorpheusImport.js E
Show 99 more ...

Let's raise the visibility of documentation in Open Source!

This page is for ingewortel/artistoo and is part of a project called "Inch CI", showing documentation measurements provided by Inch. Inch CI also provides a badge: (not counting low priority objects)

Can I have my own badges?

Sure! To get the badge for the project you are looking at, just click the badge next to the project name.

To register another project with Inch CI, just enter your username/repo on the homepage or sign in with GitHub!

Can I tell Inch which files to evaluate?

No problemo! Learn how ...

Can I configure a webhook for continuous integration?

Of course! Learn how ...

What is the goal of this?

I really think that posting badges for documentation in READMEs will benefit you (because people can see that your project is well documented) and our community in general by improving the visibility of documentation.

Let's start a discussion, let's raise the visibility of documentation, let's talk.

Suggestions, feedback, critique: Hit me up on Twitter or via issue.