InsectBrainCompartment (SNT Javadocs 0-SNAPSHOT API)

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 and Description

protected InsectBrainCompartment()

Constructors
Modifier	Constructor and Description
`protected`	`InsectBrainCompartment()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`acronym()`
`String[]`	`aliases()`
`boolean`	`equals(Object o)`
`BrainAnnotation`	`getAncestor(int level)`
`OBJMesh`	`getMesh()`
`int`	`getOntologyDepth()`
`BrainAnnotation`	`getParent()`
`int`	`hashCode()`
`int`	`id()`
`boolean`	`isChildOf(BrainAnnotation annotation)`
`boolean`	`isMeshAvailable()`
`boolean`	`isParentOf(BrainAnnotation parentCompartment)`
`String`	`name()`
`protected void`	`setAcronym(String acronym)`
`protected void`	`setAliases(String[] aliases)`
`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

Methods inherited from interface sc.fiji.snt.annotation.BrainAnnotation
getHemisphereFlag

- Constructor Detail
  - InsectBrainCompartment
```
protected InsectBrainCompartment()
```
- Method Detail
  - id
```
public int id()
```
    Specified by:
    
    id in interface BrainAnnotation
    
    Returns:
    
    the compartment's unique id
  - name
```
public String name()
```
    Specified by:
    
    name in interface BrainAnnotation
    
    Returns:
    
    the compartment's name
  - acronym
```
public String acronym()
```
    Specified by:
    
    acronym in interface BrainAnnotation
    
    Returns:
    
    the compartment's acronym
  - aliases
```
public String[] aliases()
```
    Specified by:
    
    aliases in interface BrainAnnotation
    
    Returns:
    
    the compartment's alias(es)
  - getMesh
```
public OBJMesh getMesh()
```
    Specified by:
    
    getMesh in interface BrainAnnotation
    
    Returns:
    
    the mesh associated with this compartment
  - isChildOf
```
public boolean isChildOf(BrainAnnotation annotation)
```
    Specified by:
    
    isChildOf in interface BrainAnnotation
    
    Returns:
    
    whether this compartment is a sub-compartment of annotation
  - isParentOf
```
public boolean isParentOf(BrainAnnotation parentCompartment)
```
    Specified by:
    
    isParentOf in interface BrainAnnotation
    
    Returns:
    
    whether this compartment is a parentCompartment of annotation
  - getOntologyDepth
```
public int getOntologyDepth()
```
    Specified by:
    
    getOntologyDepth in interface BrainAnnotation
  - isMeshAvailable
```
public boolean isMeshAvailable()
```
    Specified by:
    
    isMeshAvailable in interface BrainAnnotation
    
    Returns:
    
    whether a mesh is available for this compartment
  - getAncestor
```
public BrainAnnotation getAncestor(int 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 of this compartment at the nth level
  - getParent
```
public BrainAnnotation getParent()
```
    Specified by:
    
    getParent in interface BrainAnnotation
    
    Returns:
    
    the parent of this compartment
  - 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)
```
  - 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

Class InsectBrainCompartment

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Constructor Detail

InsectBrainCompartment

Method Detail

id

name

acronym

aliases

getMesh

isChildOf

isParentOf

getOntologyDepth

isMeshAvailable

getAncestor

getParent

setID

setName

setAcronym

setAliases

setUUID

setObjPath

setObjColor

setHemisphere

setSpeciesID

setSex

setType

setParent

equals

hashCode