![]() |
![]() |
![]() |
mialm Reference Manual | ![]() |
---|---|---|---|---|
Top | Description |
MiaLandmarklist; void mia_landmarklist_clear_locations (MiaLandmarklist *self
); void mia_landmarklist_delete_landmark (MiaLandmarklist *self
,const gchar *key
); void mia_landmarklist_foreach (MiaLandmarklist *self
,GHFunc callback
,gpointer user_data
); MiaLandmark * mia_landmarklist_get_landmark (MiaLandmarklist *self
,const gchar *key
); const gchar * mia_landmarklist_get_name (MiaLandmarklist *self
); const gchar * mia_landmarklist_get_selected (MiaLandmarklist *self
); gboolean mia_landmarklist_insert (MiaLandmarklist *self
,MiaLandmark *lm
); MiaLandmarklist * mia_landmarklist_new (const gchar *name
); void mia_landmarklist_set_name (MiaLandmarklist *self
,const gchar *name
); void mia_landmarklist_set_selected (MiaLandmarklist *self
,const gchar *selected
); gboolean mia_landmarklist_test (void
); gboolean mia_landmarklist_xmlio_write (xmlNodePtr parent
,xmlNsPtr ns
,MiaLandmarklist *list
);
A MiaLandmarklist comprises a series of anatomical landmarks stored as MiaLandmark. Functions are provided to manupilate and iterate the landmark list.
typedef struct _MiaLandmarklist MiaLandmarklist;
MiaLandmarklist is an opaque structure to store landmarks in 3D space.
void mia_landmarklist_clear_locations (MiaLandmarklist *self
);
Clear the 3D location information for all landmarks.
|
a landmark list |
void mia_landmarklist_delete_landmark (MiaLandmarklist *self
,const gchar *key
);
Delete the landmark with name key
from the list if it exists.
|
a landmark list |
|
a landmark name |
void mia_landmarklist_foreach (MiaLandmarklist *self
,GHFunc callback
,gpointer user_data
);
Iterate over the landmark ist and execute callback
for each landmark.
|
a landmark list |
|
a callback function GHFunc |
|
User provided additional data. [closure] |
MiaLandmark * mia_landmarklist_get_landmark (MiaLandmarklist *self
,const gchar *key
);
Retrive a landmark based on the given landmark name key
|
a landmark list |
|
a landmark name |
Returns : |
the MiaLandmark if it exists in the list, otherwise NULL |
const gchar * mia_landmarklist_get_name (MiaLandmarklist *self
);
Retrive the name of the landmark list.
|
a landmark list |
Returns : |
The name of the landmark list. If not set, return an empty string. |
const gchar * mia_landmarklist_get_selected (MiaLandmarklist *self
);
Get the currently selected landmark in self. No information is given whether the name actually exists within the landmark list.
|
a landmark list |
Returns : |
name of the currently selected landmark or an empty string. |
gboolean mia_landmarklist_insert (MiaLandmarklist *self
,MiaLandmark *lm
);
Insert the landmark lm into the landmark list if it doesn't already exists.
MiaLandmarklist * mia_landmarklist_new (const gchar *name
);
Create a new landmark list with the given name.
|
landmark list name |
void mia_landmarklist_set_name (MiaLandmarklist *self
,const gchar *name
);
(Re-)set the name of the lansmark list to name
.
|
a landmark list |
|
a name |
void mia_landmarklist_set_selected (MiaLandmarklist *self
,const gchar *selected
);
Set the currently selected landmark based on the name of the passed landmark It is not tested whether the name actually exists.
|
a landmark list |
|
a landmark name |
gboolean mia_landmarklist_test (void
);
Run some basic tests on the landmark list implementation.
Returns : |
TRUE if successful. |
gboolean mia_landmarklist_xmlio_write (xmlNodePtr parent
,xmlNsPtr ns
,MiaLandmarklist *list
);
This function adds the landmark list
as child node to the given parent
node.