anatomist  5.1.2
3D neuroimaging data viewer
anatomist::Referential Class Reference

Referential: marker for transformations, with an associated color. More...

#include <anatomist/reference/Referential.h>

Collaboration diagram for anatomist::Referential:

Public Member Functions

 Referential ()
 
 Referential (const std::string &filename)
 
 Referential (std::set< AObject * > &)
 
 Referential (std::set< AWindow * > &)
 
 Referential (const Referential &ref)
 
virtual ~Referential ()
 
Referentialoperator= (const Referential &)
 
std::set< AObject * > AnaObj (void) const
 objects which are currently in this referential More...
 
std::set< AWindow * > AnaWin (void) const
 windows which are currently in this referential More...
 
AimsRGB Color () const
 
void setColor (const AimsRGB &col)
 
int index () const
 Unique index, 0 is always the central referential. More...
 
void AddObject (AObject *)
 Ajoute un objet dans la liste des objets. More...
 
void AddWindow (AWindow *)
 Ajoute une fenetre dans la liste des fenetres. More...
 
void RemoveObject (AObject *)
 Enleve un objet de la liste des objets. More...
 
void RemoveWindow (AWindow *)
 Enleve une fenetre de la liste des fenetres. More...
 
bool destroying () const
 
carto::UUID uuid () const
 
const aims::PythonHeaderheader () const
 
aims::PythonHeaderheader ()
 
bool load (const std::string &filename)
 
std::string filename () const
 
bool isDirect () const
 
bool hidden () const
 a hidden referential does not appear in the GUI. More...
 

Static Public Member Functions

static ReferentialreferentialOfUUID (const carto::UUID &uuid)
 
static ReferentialreferentialOfUUID (const std::string &uuid)
 
static ReferentialacPcReferential ()
 
static ReferentialmniTemplateReferential ()
 
static ReferentialgiftiTalairachReferential ()
 
static ReferentialreferentialOfNameOrUUID (const AObject *obj, const std::string &refname)
 tries to find a ref in the referentials property list More...
 
static ReferentialreferentialOfName (const std::string &refname)
 WARNING: a referential may not have a unique name. More...
 
static void clearUnusedReferentials ()
 
static bool mergeReferentials (Referential *r1, Referential *r2)
 merge 2 unconnected referential or connected by identity. More...
 
static void mergeIdenticalReferentials ()
 

Protected Member Functions

AimsRGB NewColor ()
 Retourne une nouvelle couleur. More...
 

Protected Attributes

std::set< AObject * > _anaObj
 
std::set< AWindow * > _anaWin
 
AimsRGB _color
 
int _indCol
 color index More...
 
bool _destroying
 
aims::PythonHeader_header
 
std::string _filename
 

Detailed Description

Referential: marker for transformations, with an associated color.

Definition at line 54 of file Referential.h.

Constructor & Destructor Documentation

◆ Referential() [1/5]

anatomist::Referential::Referential ( )

◆ Referential() [2/5]

anatomist::Referential::Referential ( const std::string &  filename)

◆ Referential() [3/5]

anatomist::Referential::Referential ( std::set< AObject * > &  )

◆ Referential() [4/5]

anatomist::Referential::Referential ( std::set< AWindow * > &  )

◆ Referential() [5/5]

anatomist::Referential::Referential ( const Referential ref)

◆ ~Referential()

virtual anatomist::Referential::~Referential ( )
virtual

Member Function Documentation

◆ acPcReferential()

static Referential* anatomist::Referential::acPcReferential ( )
static

◆ AddObject()

void anatomist::Referential::AddObject ( AObject )

Ajoute un objet dans la liste des objets.

◆ AddWindow()

void anatomist::Referential::AddWindow ( AWindow )

Ajoute une fenetre dans la liste des fenetres.

◆ AnaObj()

std::set<AObject*> anatomist::Referential::AnaObj ( void  ) const
inline

objects which are currently in this referential

Definition at line 67 of file Referential.h.

References _anaObj.

◆ AnaWin()

std::set<AWindow*> anatomist::Referential::AnaWin ( void  ) const
inline

windows which are currently in this referential

Definition at line 69 of file Referential.h.

References _anaWin.

◆ clearUnusedReferentials()

static void anatomist::Referential::clearUnusedReferentials ( )
static

◆ Color()

AimsRGB anatomist::Referential::Color ( ) const
inline

Definition at line 70 of file Referential.h.

References _color.

◆ destroying()

bool anatomist::Referential::destroying ( ) const
inline

Definition at line 82 of file Referential.h.

References _destroying.

◆ filename()

std::string anatomist::Referential::filename ( ) const

◆ giftiTalairachReferential()

static Referential* anatomist::Referential::giftiTalairachReferential ( )
static

◆ header() [1/2]

aims::PythonHeader& anatomist::Referential::header ( )
inline

Definition at line 85 of file Referential.h.

References _header.

◆ header() [2/2]

const aims::PythonHeader& anatomist::Referential::header ( ) const
inline

Definition at line 84 of file Referential.h.

References _header.

◆ hidden()

bool anatomist::Referential::hidden ( ) const

a hidden referential does not appear in the GUI.

This function is merely a shortcut to the header property "hidden".

◆ index()

int anatomist::Referential::index ( ) const
inline

Unique index, 0 is always the central referential.

Definition at line 73 of file Referential.h.

References _indCol.

◆ isDirect()

bool anatomist::Referential::isDirect ( ) const

◆ load()

bool anatomist::Referential::load ( const std::string &  filename)

◆ mergeIdenticalReferentials()

static void anatomist::Referential::mergeIdenticalReferentials ( )
static

◆ mergeReferentials()

static bool anatomist::Referential::mergeReferentials ( Referential r1,
Referential r2 
)
static

merge 2 unconnected referential or connected by identity.

r2 will be deleted, objects/windows in ref r2 will be moved to r1. If r2 is a non-destructible referential (AC/PC...) then r1 will be deleted.

Returns
false if r1 and r2 are connected by a non-identity transform.

◆ mniTemplateReferential()

static Referential* anatomist::Referential::mniTemplateReferential ( )
static

◆ NewColor()

AimsRGB anatomist::Referential::NewColor ( )
protected

Retourne une nouvelle couleur.

◆ operator=()

Referential& anatomist::Referential::operator= ( const Referential )

◆ referentialOfName()

static Referential* anatomist::Referential::referentialOfName ( const std::string &  refname)
static

WARNING: a referential may not have a unique name.

◆ referentialOfNameOrUUID()

static Referential* anatomist::Referential::referentialOfNameOrUUID ( const AObject obj,
const std::string &  refname 
)
static

tries to find a ref in the referentials property list

◆ referentialOfUUID() [1/2]

static Referential* anatomist::Referential::referentialOfUUID ( const carto::UUID uuid)
static

◆ referentialOfUUID() [2/2]

static Referential* anatomist::Referential::referentialOfUUID ( const std::string &  uuid)
static

◆ RemoveObject()

void anatomist::Referential::RemoveObject ( AObject )

Enleve un objet de la liste des objets.

◆ RemoveWindow()

void anatomist::Referential::RemoveWindow ( AWindow )

Enleve une fenetre de la liste des fenetres.

◆ setColor()

void anatomist::Referential::setColor ( const AimsRGB col)

◆ uuid()

carto::UUID anatomist::Referential::uuid ( ) const

Member Data Documentation

◆ _anaObj

std::set<AObject*> anatomist::Referential::_anaObj
protected

Definition at line 115 of file Referential.h.

Referenced by AnaObj().

◆ _anaWin

std::set<AWindow*> anatomist::Referential::_anaWin
protected

Definition at line 116 of file Referential.h.

Referenced by AnaWin().

◆ _color

AimsRGB anatomist::Referential::_color
protected

Definition at line 117 of file Referential.h.

Referenced by Color().

◆ _destroying

bool anatomist::Referential::_destroying
protected

Definition at line 120 of file Referential.h.

Referenced by destroying().

◆ _filename

std::string anatomist::Referential::_filename
protected

Definition at line 124 of file Referential.h.

◆ _header

aims::PythonHeader* anatomist::Referential::_header
protected

Definition at line 121 of file Referential.h.

Referenced by header().

◆ _indCol

int anatomist::Referential::_indCol
protected

color index

Definition at line 119 of file Referential.h.

Referenced by index().


The documentation for this class was generated from the following file: