CiftiLib
A C++ library for CIFTI-2 and CIFTI-1 files
Public Types | Public Member Functions | Static Public Member Functions | List of all members
cifti::CiftiSeriesMap Class Reference
Inheritance diagram for cifti::CiftiSeriesMap:
cifti::CiftiMappingType

Public Types

enum  Unit { HERTZ , METER , RADIAN , SECOND }
 
- Public Types inherited from cifti::CiftiMappingType
enum  MappingType {
  BRAIN_MODELS , PARCELS , SERIES , SCALARS ,
  LABELS
}
 

Public Member Functions

float getStart () const
 
float getStep () const
 
Unit getUnit () const
 
 CiftiSeriesMap (const int64_t &length, const float &start=0.0f, const float &step=1.0f, const Unit &unit=SECOND)
 
void setStart (const float &start)
 
void setStep (const float &step)
 
void setUnit (const Unit &unit)
 
void setLength (const int64_t &length)
 
CiftiMappingTypeclone () const
 
MappingType getType () const
 
int64_t getLength () const
 
bool operator== (const CiftiMappingType &rhs) const
 
bool approximateMatch (const CiftiMappingType &rhs, AString *explanation=NULL) const
 
void readXML1 (XmlReader &xml)
 
void readXML2 (XmlReader &xml)
 
void writeXML1 (XmlWriter &xml) const
 
void writeXML2 (XmlWriter &xml) const
 
- Public Member Functions inherited from cifti::CiftiMappingType
virtual CiftiMappingTypeclone () const =0
 
virtual MappingType getType () const =0
 
virtual int64_t getLength () const =0
 
virtual bool operator== (const CiftiMappingType &rhs) const =0
 
bool operator!= (const CiftiMappingType &rhs) const
 
virtual bool approximateMatch (const CiftiMappingType &rhs, AString *explanation=NULL) const =0
 
virtual void readXML1 (XmlReader &xml)=0
 
virtual void readXML2 (XmlReader &xml)=0
 
virtual void writeXML1 (XmlWriter &xml) const =0
 
virtual void writeXML2 (XmlWriter &xml) const =0
 

Static Public Member Functions

static Unit stringToUnit (const AString &string, bool &ok)
 
static AString unitToString (const Unit &theUnit)
 
static std::vector< Unit > getAllUnits ()
 
- Static Public Member Functions inherited from cifti::CiftiMappingType
static AString mappingTypeToName (const MappingType &type)
 

Member Function Documentation

◆ approximateMatch()

bool cifti::CiftiSeriesMap::approximateMatch ( const CiftiMappingType rhs,
AString *  explanation = NULL 
) const
inlinevirtual

◆ clone()

CiftiMappingType * cifti::CiftiSeriesMap::clone ( ) const
inlinevirtual

◆ getLength()

int64_t cifti::CiftiSeriesMap::getLength ( ) const
inlinevirtual

◆ getType()

MappingType cifti::CiftiSeriesMap::getType ( ) const
inlinevirtual

◆ operator==()

bool cifti::CiftiSeriesMap::operator== ( const CiftiMappingType rhs) const
inlinevirtual

◆ readXML1()

void CiftiSeriesMap::readXML1 ( XmlReader &  xml)
virtual

◆ readXML2()

void CiftiSeriesMap::readXML2 ( XmlReader &  xml)
virtual

◆ writeXML1()

void CiftiSeriesMap::writeXML1 ( XmlWriter &  xml) const
virtual

◆ writeXML2()

void CiftiSeriesMap::writeXML2 ( XmlWriter &  xml) const
virtual

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