Field Detail

• LEFT_HEMISPHERE

  static final char LEFT_HEMISPHERE

  See Also:

  Constant Field Values

• RIGHT_HEMISPHERE

  static final char RIGHT_HEMISPHERE

  See Also:

  Constant Field Values

• ANY_HEMISPHERE

  static final char ANY_HEMISPHERE

  See Also:

  Constant Field Values

Method Detail

• id

  int id()

  Returns:

  the compartment's unique id

• name

  String name()

  Returns:

  the compartment's name

• acronym

  String acronym()

  Returns:

  the compartment's acronym

• aliases

  String[] aliases()

  Returns:

  the compartment's alias(es)

• getMesh

  OBJMesh getMesh()

  Returns:

  the mesh associated with this compartment

• isChildOf

  boolean isChildOf(BrainAnnotation annotation)

  Returns:

  whether this compartment is a sub-compartment of annotation

• isParentOf

  boolean isParentOf(BrainAnnotation parentCompartment)

  Returns:

  whether this compartment is a parentCompartment of annotation

• getOntologyDepth

  int getOntologyDepth()

• isMeshAvailable

  boolean isMeshAvailable()

  Returns:

  whether a mesh is available for this compartment

• getAncestor

  BrainAnnotation getAncestor(int level)

  Parameters:

  level - the ancestor level as negative 1-based index. E.g., -1 retrieves the last ancestor (parent), -2 retrieves the second to last, etc

  Returns:

  the ancestor of this compartment at the nth level

• getParent

  BrainAnnotation getParent()

  Returns:

  the parent of this compartment

• getHemisphereFlag

  static char getHemisphereFlag(String hemisphere)