Seg3D  2.4
Seg3D is a free volume segmentation and processing tool developed by the NIH Center for Integrative Biomedical Computing at the University of Utah Scientific Computing and Imaging (SCI) Institute.
Public Member Functions | Static Public Member Functions | List of all members
Core::DataVolume Class Reference
Inheritance diagram for Core::DataVolume:

Public Member Functions

 DataVolume (const GridTransform &grid_transform, const DataBlockHandle &data_block)
 
virtual VolumeType get_type () const
 Get the type of the data volume.
 
virtual double get_min () const
 Get the minimum value.
 
virtual double get_max () const
 Get the maximum value.
 
virtual double get_cum_value (double fraction) const
 Get the value at a specific point in the histogram.
 
virtual bool is_valid () const
 Check whether the volume has a valid data block.
 
DataBlockHandle get_data_block () const
 Get the data block that contains the volume data.
 
DataType get_data_type () const
 Get the data type of the data in this volume.
 
virtual mutex_type & get_mutex ()
 Get access to the mutex protecting this DataVolume.
 
virtual NrrdDataHandle convert_to_nrrd ()
 Get the volume data as a nrrd wrapped in a NrrdData structure.
 
virtual DataBlock::generation_type get_generation () const
 Get the generation number of the data volume.
 
virtual DataBlock::generation_type register_data (DataBlock::generation_type generation=-1)
 Register the underlying data with the DataBlockManager.
 
virtual void unregister_data ()
 Unregister the underlying data with DataBlockManager.
 
virtual size_t get_byte_size () const
 Get the size of the data in bytes.
 
void get_bricks (std::vector< DataVolumeBrickHandle > &bricks)
 Split the volume into small bricks if not yet generated, and return a vector of the bricks.
 
bool insert_slice (const DataSliceHandle slice)
 Insert a slice into the volume.
 
bool extract_slice (SliceType type, DataBlock::index_type index, DataSliceHandle &slice)
 Extract a slice from the volume.
 

Static Public Member Functions

static bool LoadDataVolume (const boost::filesystem::path &filename, DataVolumeHandle &volume, std::string &error)
 Load a DataVolume from a nrrd file.
 
static bool SaveDataVolume (const boost::filesystem::path &filepath, DataVolumeHandle &volume, std::string &error, bool compress, int level)
 Save a DataVolume to a nrrd file.
 
static bool CreateEmptyData (GridTransform grid_transform, DataType data_type, DataVolumeHandle &data)
 Create an empty data volume with given dimensions.
 
static bool CreateInvalidData (GridTransform grid_transform, DataVolumeHandle &data)
 Create a data volume with given dimensions, but no data container associated with it.
 
static bool ConvertToCanonicalVolume (const DataVolumeHandle &src_volume, DataVolumeHandle &dst_volume)
 
static bool DuplicateVolume (const DataVolumeHandle &src_mask, DataVolumeHandle &dst_mask)
 Duplicate the data volume.
 

Member Function Documentation

bool Core::DataVolume::ConvertToCanonicalVolume ( const DataVolumeHandle &  src_volume,
DataVolumeHandle &  dst_volume 
)
static

Convert the source volume to a canonical-axis-aligned volume. Returns true if conversion is done, otherwise false.


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