Package sc.fiji.snt.annotation

Class InsectBrainCompartment

java.lang.Object

sc.fiji.snt.annotation.InsectBrainCompartment

All Implemented Interfaces:

BrainAnnotation

public class InsectBrainCompartment
extends Object
implements BrainAnnotation

Author:

Cameron Arshadi, Tiago Ferreira

Field Summary

Fields inherited from interface sc.fiji.snt.annotation.BrainAnnotation

ANY_HEMISPHERE, LEFT_HEMISPHERE, RIGHT_HEMISPHERE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	InsectBrainCompartment()

Method Summary

Modifier and Type	Method	Description
String	acronym()	Returns the compartment's acronym.
String[]	aliases()	Returns the compartment's alias(es).
org.scijava.util.ColorRGB	color()	Returns the display color of this compartment (if known).
boolean	equals(Object o)
BrainAnnotation	getAncestor(int level)	Returns the ancestor of this compartment at the specified level.
OBJMesh	getMesh()	Returns the mesh associated with this compartment.
int	getOntologyDepth()	Returns the ontology depth of this compartment.
BrainAnnotation	getParent()	Returns the parent of this compartment.
int	hashCode()
int	id()	Returns the compartment's unique id.
boolean	isChildOf(BrainAnnotation annotation)	Returns whether this compartment is a sub-compartment of annotation.
boolean	isMeshAvailable()	Returns whether a mesh is available for this compartment.
boolean	isParentOf(BrainAnnotation parentCompartment)	Returns whether this compartment is a parent of parentCompartment.
String	name()	Returns the compartment's name.
protected void	setAcronym(String acronym)
protected void	setAliases(String[] aliases)
protected void	setFileUUID(UUID fileUUID)
protected void	setHemisphere(Object hemisphere)
protected void	setID(int id)
protected void	setName(String name)
protected void	setObjColor(String objColor)
protected void	setObjPath(String objPath)
protected void	setParent(BrainAnnotation parent)
protected void	setSex(String sex)
protected void	setSpeciesID(int speciesId)
protected void	setType(String type)
protected void	setUUID(UUID uuid)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

InsectBrainCompartment

protected InsectBrainCompartment()

Method Details

id

public int id()

Description copied from interface: BrainAnnotation

Returns the compartment's unique id.

Specified by:

id in interface BrainAnnotation

name

public String name()

Description copied from interface: BrainAnnotation

Returns the compartment's name.

Specified by:

name in interface BrainAnnotation

acronym

public String acronym()

Description copied from interface: BrainAnnotation

Returns the compartment's acronym.

Specified by:

acronym in interface BrainAnnotation

aliases

public String[] aliases()

Description copied from interface: BrainAnnotation

Returns the compartment's alias(es).

Specified by:

aliases in interface BrainAnnotation

getMesh

public OBJMesh getMesh()

Description copied from interface: BrainAnnotation

Returns the mesh associated with this compartment.

Specified by:

getMesh in interface BrainAnnotation

isChildOf

public boolean isChildOf(BrainAnnotation annotation)

Description copied from interface: BrainAnnotation

Returns whether this compartment is a sub-compartment of annotation.

Specified by:

isChildOf in interface BrainAnnotation

isParentOf

public boolean isParentOf(BrainAnnotation parentCompartment)

Description copied from interface: BrainAnnotation

Returns whether this compartment is a parent of parentCompartment.

Specified by:

isParentOf in interface BrainAnnotation

getOntologyDepth

public int getOntologyDepth()

Description copied from interface: BrainAnnotation

Returns the ontology depth of this compartment.

Specified by:

getOntologyDepth in interface BrainAnnotation

isMeshAvailable

public boolean isMeshAvailable()

Description copied from interface: BrainAnnotation

Returns whether a mesh is available for this compartment.

Specified by:

isMeshAvailable in interface BrainAnnotation

getAncestor

public BrainAnnotation getAncestor(int level)

Description copied from interface: BrainAnnotation

Returns the ancestor of this compartment at the specified level.

Specified by:

getAncestor in interface BrainAnnotation

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 at the given level

getParent

public BrainAnnotation getParent()

Description copied from interface: BrainAnnotation

Returns the parent of this compartment.

Specified by:

getParent in interface BrainAnnotation

setID

protected void setID(int id)

setName

protected void setName(String name)

setAcronym

protected void setAcronym(String acronym)

setAliases

protected void setAliases(String[] aliases)

setUUID

protected void setUUID(UUID uuid)

setObjPath

protected void setObjPath(String objPath)

setFileUUID

protected void setFileUUID(UUID fileUUID)

setObjColor

protected void setObjColor(String objColor)

setHemisphere

protected void setHemisphere(Object hemisphere)

setSpeciesID

protected void setSpeciesID(int speciesId)

setSex

protected void setSex(String sex)

setType

protected void setType(String type)

setParent

protected void setParent(BrainAnnotation parent)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

color

public org.scijava.util.ColorRGB color()

Description copied from interface: BrainAnnotation

Returns the display color of this compartment (if known).

Specified by:

color in interface BrainAnnotation