brainrat-private 6.0.4
bio::DpyData Class Reference

The data class of the dpy format. More...

#include <brainrat/data/dpydata.h>

Public Member Functions

 DpyData (int dimX=1, int dimY=1, int dimZ=1, int dimT=1, string syntax="__generic__")
 
virtual ~DpyData ()
 
void setHeader (DpyHeader &header)
 
DpyHeader header () const
 
void setContent (Object &content)
 
Object & content ()
 
const Object & content () const
 
int dimX () const
 
int dimY () const
 
int dimZ () const
 
int dimT () const
 
int dim (uint index) const
 
void setDim (uint index, int dim)
 
float sizeX () const
 
float sizeY () const
 
float sizeZ () const
 
float sizeT () const
 
float size (uint index) const
 
void setSizeX (float size)
 
void setSizeY (float size)
 
void setSizeZ (float size)
 
void setSizeT (float size)
 
void setSize (uint index, float size)
 

Detailed Description

The data class of the dpy format.

Definition at line 24 of file dpydata.h.

Constructor & Destructor Documentation

◆ DpyData()

bio::DpyData::DpyData ( int dimX = 1,
int dimY = 1,
int dimZ = 1,
int dimT = 1,
string syntax = "__generic__" )

References dimT(), dimX(), dimY(), and dimZ().

◆ ~DpyData()

virtual bio::DpyData::~DpyData ( )
inlinevirtual

Definition at line 28 of file dpydata.h.

Member Function Documentation

◆ content() [1/2]

Object & bio::DpyData::content ( )
inline

Definition at line 34 of file dpydata.h.

Referenced by setContent(), and bio::DpyWriter::write().

◆ content() [2/2]

const Object & bio::DpyData::content ( ) const
inline

Definition at line 35 of file dpydata.h.

◆ dim()

int bio::DpyData::dim ( uint index) const

Referenced by setDim().

◆ dimT()

int bio::DpyData::dimT ( ) const

Referenced by DpyData().

◆ dimX()

int bio::DpyData::dimX ( ) const

Referenced by DpyData().

◆ dimY()

int bio::DpyData::dimY ( ) const

Referenced by DpyData().

◆ dimZ()

int bio::DpyData::dimZ ( ) const

Referenced by DpyData().

◆ header()

DpyHeader bio::DpyData::header ( ) const
inline

Definition at line 31 of file dpydata.h.

Referenced by setHeader(), and bio::DpyWriter::write().

◆ setContent()

void bio::DpyData::setContent ( Object & content)
inline

Definition at line 33 of file dpydata.h.

References content().

Referenced by bio::DpyReader::read().

◆ setDim()

void bio::DpyData::setDim ( uint index,
int dim )

References dim().

◆ setHeader()

void bio::DpyData::setHeader ( DpyHeader & header)
inline

Definition at line 30 of file dpydata.h.

References header().

Referenced by bio::DpyReader::read().

◆ setSize()

void bio::DpyData::setSize ( uint index,
float size )

References size().

◆ setSizeT()

void bio::DpyData::setSizeT ( float size)

References size().

◆ setSizeX()

void bio::DpyData::setSizeX ( float size)

References size().

◆ setSizeY()

void bio::DpyData::setSizeY ( float size)

References size().

◆ setSizeZ()

void bio::DpyData::setSizeZ ( float size)

References size().

◆ size()

float bio::DpyData::size ( uint index) const

◆ sizeT()

float bio::DpyData::sizeT ( ) const

◆ sizeX()

float bio::DpyData::sizeX ( ) const

◆ sizeY()

float bio::DpyData::sizeY ( ) const

◆ sizeZ()

float bio::DpyData::sizeZ ( ) const

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