Skip to content

Main content

Cellular Potts One Contact Energy Term Tool

One Cellular Potts interfacial J*(1-delta(cellId1,cellId2)) contribution; coefficient is supplied, including its sign.

Loading tool…

Description

Return a supplied cellular-Potts contact-energy term.

Biological balance models use signed changes, conserved weights, compartment amounts and spatial conventions. A local term can preserve a supplied bookkeeping identity while the actual reactions, volumes, boundary conditions and biological interpretation still require a complete model.

Return a supplied cellular-Potts contact-energy term.

When to use this tool

Use Cellular Potts One Contact Energy Term when checking one supplied biological balance, compartment or grid contribution.

How to use the tool and how it works

  1. Enter firstCell, secondCell, contactCoefficient, contactMeasure. Use the units and conventions below.
  2. Run the tool. Correct any format, range, or cross-field input error before interpreting the output.
  3. Read sameCell, energy. Inspect sameCell before interpreting the associated values.

Return a supplied cellular-Potts contact-energy term. Require nonnegative whole cell IDs and contactMeasure >= 0; sameCell uses ID equality, energy is zero then, otherwise contactCoefficient*measure.1

Input fieldMeaning and unitsAccepted input
firstCellFirst CellRequired. Safe integer; minimum 0.
secondCellSecond CellRequired. Safe integer; minimum 0.
contactCoefficientContact CoefficientRequired. Finite number.
contactMeasureContact MeasureRequired. Finite number; minimum 0.
Output fieldInterpretationReturned shape
sameCellSame CellRequired. Boolean.
energyEnergyRequired. Finite number.
json
{
  "input": {
    "firstCell": 1,
    "secondCell": 2,
    "contactCoefficient": 3,
    "contactMeasure": 4
  },
  "output": {
    "sameCell": false,
    "energy": 12
  }
}

Limitations and assumptions

  • A signed coefficient is retained; this is one contact contribution rather than a full Hamiltonian or a sampled cell rearrangement.
  • Inputs must satisfy both the field types and the cross-field conditions above. Invalid input causes an error; a successful false flag or documented placeholder is a different result.
  • Numeric calculations use binary floating point unless exact decimal-integer arithmetic is explicitly stated. No hidden measurement tolerance or decimal rounding is added; nonfinite or out-of-contract results are rejected. Numeric signed-zero results are exported as zero.

Alternative or Complementary methods

Use a complete dimensionally consistent reaction/transport model with verified parameters and suitable numerical methods for biological predictions.

References

  1. Calculation and input contract: computational-biology/cellular-potts-one-contact-energy-term — tool.io

Similar or alternative tools