iRoCS Toolbox  1.1.0
Public Member Functions | Data Fields
AnnotationChannelMetaData Struct Reference

#include <HDF5DataIO.hh>

Inheritance diagram for AnnotationChannelMetaData:
Collaboration diagram for AnnotationChannelMetaData:

Public Member Functions

 AnnotationChannelMetaData ()
 
 AnnotationChannelMetaData (AnnotationChannelSpecs *specs)
 
 ~AnnotationChannelMetaData ()
 
void load (const std::string &h5FileName, int index)
 Load the general metadata of channel with index <index> out of the .labelling_qt4 group of the hdf5 file specified by filename. More...
 
int save (const std::string &h5FileName)
 Save the general metadata stored in this struct into the .labelling_qt4 group of the hdf5 file specified by filename. More...
 

Data Fields

std::vector< int > activeLabels
 
float alpha
 
std::string channelName
 
std::string channelType
 
std::map< int, blitz::TinyVector< float, 3 > > colorMap
 
Marker::MarkerType markerType
 
bool visible
 

Detailed Description

Definition at line 129 of file HDF5DataIO.hh.

Constructor & Destructor Documentation

◆ AnnotationChannelMetaData() [1/2]

AnnotationChannelMetaData::AnnotationChannelMetaData ( )

◆ AnnotationChannelMetaData() [2/2]

AnnotationChannelMetaData::AnnotationChannelMetaData ( AnnotationChannelSpecs specs)

◆ ~AnnotationChannelMetaData()

AnnotationChannelMetaData::~AnnotationChannelMetaData ( )

Member Function Documentation

◆ load()

void AnnotationChannelMetaData::load ( const std::string &  h5FileName,
int  index 
)
virtual

Load the general metadata of channel with index <index> out of the .labelling_qt4 group of the hdf5 file specified by filename.

Parameters
h5FileNameThe name of the hdf5 file to read the metadata from
indexThe channel index
Exceptions
BlitzH5Errorwhen something goes wrong

Reimplemented from ChannelMetaData.

◆ save()

int AnnotationChannelMetaData::save ( const std::string &  h5FileName)
virtual

Save the general metadata stored in this struct into the .labelling_qt4 group of the hdf5 file specified by filename.

If a .labelling_qt4 group exists an entry with corresponding channelName is searched and updated if found. If not a new set of attributes is created, and the nChannels attribute is incremented.

Parameters
h5FileNameThe name of the hdf5 file to write the metadata to
Exceptions
BlitzH5Errorwhen something goes wrong
Returns
The index of the channel within the structure

Reimplemented from ChannelMetaData.

Field Documentation

◆ markerType

Marker::MarkerType AnnotationChannelMetaData::markerType

Definition at line 138 of file HDF5DataIO.hh.

◆ activeLabels

std::vector<int> AnnotationChannelMetaData::activeLabels

Definition at line 139 of file HDF5DataIO.hh.

◆ colorMap

std::map< int, blitz::TinyVector<float,3> > AnnotationChannelMetaData::colorMap

Definition at line 140 of file HDF5DataIO.hh.

◆ channelName

std::string ChannelMetaData::channelName
inherited

Definition at line 88 of file HDF5DataIO.hh.

◆ channelType

std::string ChannelMetaData::channelType
inherited

Definition at line 89 of file HDF5DataIO.hh.

◆ alpha

float ChannelMetaData::alpha
inherited

Definition at line 90 of file HDF5DataIO.hh.

◆ visible

bool ChannelMetaData::visible
inherited

Definition at line 91 of file HDF5DataIO.hh.


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