SOFA API  3ea83cbd
Open source framework for multi-physics simuation
sofa::component::io::mesh::VoxelGridLoader Class Reference

#include <VoxelGridLoader.h>

Inheritance diagram for sofa::component::io::mesh::VoxelGridLoader:

Public Attributes

Data< type::Vec3voxelSize
 Dimension of one voxel. More...
 
Data< Vec3idataResolution
 Resolution of the voxel file. More...
 
Data< Vec6iroi
 Region of interest (xmin, ymin, zmin, xmax, ymax, zmax) More...
 
Data< int > headerSize
 Header size in bytes. More...
 
Data< int > segmentationHeaderSize
 Header size in bytes. More...
 
Data< type::vector< unsigned int > > idxInRegularGrid
 indices of the hexa in the grid. More...
 
Data< type::vector< int > > backgroundValue
 Background values (to be ignored) More...
 
Data< type::vector< int > > activeValue
 Active data values. More...
 
Data< boolgenerateHexa
 Interpret voxel as either hexa or points. More...
 
- Public Attributes inherited from sofa::core::loader::VoxelLoader
Data< type::vector< sofa::type::Vec3 > > positions
 Coordinates of the nodes loaded. More...
 
Data< type::vector< Hexahedron > > hexahedra
 Hexahedra loaded. More...
 
- Public Attributes inherited from sofa::core::loader::BaseLoader
objectmodel::DataFileName d_filename
 
- Public Attributes inherited from sofa::core::objectmodel::BaseObject
Data< boolf_listening
 if true, handle the events, otherwise ignore the events More...
 
- Public Attributes inherited from sofa::core::objectmodel::Base
std::vector< lifecycle::DeprecatedData * > m_oldAttributes
 
Data< int > d_messageLogCount
 
Data< std::string > name
 Name of the object. More...
 
Data< boolf_printLog
 if true, emits extra messages at runtime. More...
 
Data< sofa::core::objectmodel::TagSetf_tags
 list of the subsets the objet belongs to More...
 
Data< sofa::type::BoundingBoxf_bbox
 this object bounding box More...
 
Data< sofa::core::objectmodel::ComponentStated_componentState
 the object state More...
 
std::string m_definitionSourceFileName {""}
 
int m_definitionSourceFilePos {-1}
 
std::string m_instanciationSourceFileName {""}
 
int m_instanciationSourceFilePos {-1}
 

Protected Attributes

helper::io::Imageimage
 
helper::io::Imagesegmentation
 
int bpp
 
- Protected Attributes inherited from sofa::core::objectmodel::BaseObject
SingleLink< BaseObject, BaseContext, BaseLink::FLAG_DOUBLELINKl_context
 
LinkSlaves l_slaves
 
SingleLink< BaseObject, BaseObject, BaseLink::FLAG_DOUBLELINKl_master
 
- Protected Attributes inherited from sofa::core::objectmodel::Base
std::map< std::string, sofa::core::DataTrackerCallbackm_internalEngine
 
VecData m_vecData
 List of fields (Data instances) More...
 
MapData m_aliasData
 name -> Data multi-map (includes names and aliases) More...
 
VecLink m_vecLink
 List of links. More...
 
MapLink m_aliasLink
 name -> Link multi-map (includes names and aliases) More...
 

Public Member Functions

 SOFA_CLASS (VoxelGridLoader, VoxelLoader)
 
void init () override
 Initialization method called at graph creation and modification, during top-down traversal. More...
 
void reinit () override
 Update method called when variables used in precomputation are modified. More...
 
virtual void clear ()
 
bool load () override
 
bool canLoad () override
 
void setVoxelSize (const type::Vec3 vSize)
 
type::Vec3 getVoxelSize () const override
 
void addBackgroundValue (const int value)
 
int getBackgroundValue (const unsigned int idx=0) const
 
void addActiveDataValue (const int value)
 
int getActiveDataValue (const unsigned int idx=0) const
 
void getResolution (Vec3i &res) const
 
int getDataSize () const override
 
unsigned chargetData () override
 
unsigned chargetSegmentID () override
 
type::vector< unsigned int > getHexaIndicesInGrid () const override
 
Vec6i getROI () const override
 
void createSegmentation3DTexture (unsigned char **textureData, int &width, int &height, int &depth) override
 
- Public Member Functions inherited from sofa::core::loader::VoxelLoader
 SOFA_ABSTRACT_CLASS (VoxelLoader, BaseLoader)
 
void addHexahedron (type::vector< Hexahedron > *pHexahedra, const type::fixed_array< unsigned int, 8 > &p)
 
void addHexahedron (type::vector< Hexahedron > *pHexahedra, unsigned int p0, unsigned int p1, unsigned int p2, unsigned int p3, unsigned int p4, unsigned int p5, unsigned int p6, unsigned int p7)
 
- Public Member Functions inherited from sofa::core::loader::BaseLoader
 SOFA_ABSTRACT_CLASS (BaseLoader, objectmodel::BaseObject)
 
void parse (objectmodel::BaseObjectDescription *arg) override
 Parse the given description to assign values to this object's fields and potentially other parameters. More...
 
void setFilename (std::string f)
 
const std::string & getFilename ()
 
- Public Member Functions inherited from sofa::core::objectmodel::BaseObject
 SOFA_CLASS (BaseObject, Base)
 
virtual void draw (const core::visual::VisualParams *)
 Render internal data of this object, for debugging purposes. More...
 
virtual void computeBBox (const core::ExecParams *, bool=false)
 
void setSrc (const std::string &v, std::vector< std::string > *attributeList=nullptr)
 Sets a source Object and parses it to collect dependent Data. More...
 
void setSrc (const std::string &v, const BaseObject *loader, std::vector< std::string > *attributeList=nullptr)
 
BasefindLinkDestClass (const BaseClass *destType, const std::string &path, const BaseLink *link) override
 
virtual std::string getPathName () const override
 Return the full path name of this object. More...
 
virtual bool insertInNode (BaseNode *)
 
virtual bool removeInNode (BaseNode *)
 
SReal getTime () const
 Current time. More...
 
const BaseContextgetContext () const
 
BaseContextgetContext ()
 
const BaseObjectgetMaster () const
 
BaseObjectgetMaster ()
 
const VecSlavesgetSlaves () const
 
BaseObjectgetSlave (const std::string &name) const
 
virtual void addSlave (BaseObject::SPtr s)
 
virtual void removeSlave (BaseObject::SPtr s)
 
virtual void handleEvent (Event *)
 Handle an event. More...
 
virtual void handleTopologyChange ()
 
virtual void handleTopologyChange (core::topology::Topology *t)
 
void parse (BaseObjectDescription *arg) override
 Parse the given description to assign values to this object's fields and potentially other parameters. More...
 
virtual void bwdInit ()
 Initialization method called at graph creation and modification, during bottom-up traversal. More...
 
void updateInternal ()
 Update method called when variables (used to compute other internal variables) are modified. More...
 
virtual void storeResetState ()
 Save the initial state for later uses in reset() More...
 
virtual void reset ()
 Reset to initial state. More...
 
virtual void cleanup ()
 
- Public Member Functions inherited from sofa::core::objectmodel::Base
virtual const BaseClassgetClass () const
 
void addDeprecatedAttribute (lifecycle::DeprecatedData *attribute)
 
void addUpdateCallback (const std::string &name, std::initializer_list< BaseData * > inputs, std::function< sofa::core::objectmodel::ComponentState(const DataTracker &)> function, std::initializer_list< BaseData * > outputs)
 
void addOutputsToCallback (const std::string &name, std::initializer_list< BaseData * > outputs)
 
const std::string & getName () const
 Accessor to the object name. More...
 
void setName (const std::string &n)
 Set the name of this object. More...
 
void setName (const std::string &n, int counter)
 Set the name of this object, adding an integer counter. More...
 
std::string getTypeName () const
 Get the type name of this object (i.e. class and template types) More...
 
virtual std::string getClassName () const
 Get the class name of this object. More...
 
virtual std::string getTemplateName () const final
 Get the template type names (if any) used to instantiate this object. More...
 
std::string getNameSpaceName () const
 Get the template type names (if any) used to instantiate this object. More...
 
void setDefinitionSourceFileName (const std::string &sourceFileName)
 Set the source filename (where the component is implemented) More...
 
const std::string & getDefinitionSourceFileName () const
 Get the source filename (where the component is implemented) More...
 
void setDefinitionSourceFilePos (const int)
 Set the source location (where the component is implemented) More...
 
int getDefinitionSourceFilePos () const
 Get the source location (where the component is implemented) More...
 
void setInstanciationSourceFileName (const std::string &sourceFileName)
 
const std::string & getInstanciationSourceFileName () const
 
void setInstanciationSourceFilePos (const int)
 
int getInstanciationSourceFilePos () const
 
void addMessage (const sofa::helper::logging::Message &m) const
 
size_t countLoggedMessages (sofa::helper::logging::Message::TypeSet t=sofa::helper::logging::Message::AnyTypes) const
 
const std::deque< sofa::helper::logging::Message > & getLoggedMessages () const
 
const std::string getLoggedMessagesAsString (sofa::helper::logging::Message::TypeSet t=sofa::helper::logging::Message::AnyTypes) const
 
void clearLoggedMessages () const
 
bool notMuted () const
 
const sofa::core::objectmodel::TagSetgetTags () const
 Represents the subsets the object belongs to. More...
 
bool hasTag (Tag t) const
 Return true if the object belong to the given subset. More...
 
void addTag (Tag t)
 Add a subset qualification to the object. More...
 
void removeTag (Tag t)
 Remove a subset qualification to the object. More...
 
ComponentState getComponentState () const
 
bool isComponentStateValid () const
 
virtual bool parseField (const std::string &attribute, const std::string &value)
 Assign one field value (Data or Link) More...
 
virtual bool hasField (const std::string &attribute) const
 Check if a given Data field or Link exists. More...
 
void parseFields (const std::list< std::string > &str)
 Assign the field values stored in the given list of name + value pairs of strings. More...
 
virtual void parseFields (const std::map< std::string, std::string * > &str)
 Assign the field values stored in the given map of name -> value pairs. More...
 
void writeDatas (std::map< std::string, std::string * > &str)
 Write the current field values to the given map of name -> value pairs. More...
 
void writeDatas (std::ostream &out, const std::string &separator=" ")
 
BaseDatafindData (const std::string &name) const
 
std::vector< BaseData * > findGlobalField (const std::string &name) const
 Find data fields given a name: several can be found as we look into the alias map. More...
 
BaseLinkfindLink (const std::string &name) const
 
std::vector< BaseLink * > findLinks (const std::string &name) const
 Find link fields given a name: several can be found as we look into the alias map. More...
 
virtual void updateLinks (bool logErrors=true)
 Update pointers in case the pointed-to objects have appeared. More...
 
template<class T >
BaseData::BaseInitData initData (::sofa::core::objectmodel::Data< T > *field, const char *name, const char *help, ::sofa::core::objectmodel::BaseData::DataFlags dataflags)
 Helper method used to initialize a data field containing a value of type T. More...
 
template<class T >
BaseData::BaseInitData initData (Data< T > *field, const char *name, const char *help, bool isDisplayed=true, bool isReadOnly=false)
 Helper method used to initialize a data field containing a value of type T. More...
 
template<class T >
Data< T >::InitData initData (Data< T > *field, const T &value, const char *name, const char *help, bool isDisplayed=true, bool isReadOnly=false)
 Helper method used to initialize a data field containing a value of type T. More...
 
void addData (BaseData *f, const std::string &name)
 
void addData (BaseData *f)
 
void removeData (BaseData *f)
 Remove a data field. More...
 
void addAlias (BaseData *field, const char *alias)
 Add an alias to a Data. More...
 
void addLink (BaseLink *l)
 Add a link. More...
 
void addAlias (BaseLink *link, const char *alias)
 Add an alias to a Link. More...
 
const VecDatagetDataFields () const
 Accessor to the vector containing all the fields of this object. More...
 
const MapDatagetDataAliases () const
 Accessor to the map containing all the aliases of this object. More...
 
const VecLinkgetLinks () const
 Accessor to the vector containing all the fields of this object. More...
 
const MapLinkgetLinkAliases () const
 Accessor to the map containing all the aliases of this object. More...
 
virtual bool findDataLinkDest (BaseData *&ptr, const std::string &path, const BaseLink *link)
 
template<class T >
bool findLinkDest (T *&ptr, const std::string &path, const BaseLink *link)
 

Protected Member Functions

 VoxelGridLoader ()
 
 ~VoxelGridLoader () override
 
- Protected Member Functions inherited from sofa::core::loader::VoxelLoader
 VoxelLoader ()
 
 ~VoxelLoader () override
 
- Protected Member Functions inherited from sofa::core::loader::BaseLoader
 BaseLoader ()
 
 ~BaseLoader () override
 
- Protected Member Functions inherited from sofa::core::objectmodel::BaseObject
 BaseObject ()
 
 ~BaseObject () override
 
virtual void doUpdateInternal ()
 Implementation of the internal update. More...
 
void changeContextLink (BaseContext *before, BaseContext *&after)
 
void changeSlavesLink (BaseObject::SPtr ptr, std::size_t, bool add)
 This method insures that slaves objects have master and context links set correctly. More...
 
void trackInternalData (const BaseData &data)
 Method called to add the Data to the DataTracker (listing the Data to track) More...
 
void cleanTracker ()
 
bool hasDataChanged (const BaseData &data)
 Method called to know if a tracked Data has changed. More...
 
- Protected Member Functions inherited from sofa::core::objectmodel::Base
 Base ()
 
virtual ~Base ()
 
void initData0 (BaseData *field, BaseData::BaseInitData &res, const char *name, const char *help, bool isDisplayed=true, bool isReadOnly=false)
 Helper method used by initData() More...
 
void initData0 (BaseData *field, BaseData::BaseInitData &res, const char *name, const char *help, BaseData::DataFlags dataFlags)
 Helper method used by initData() More...
 
template<class T >
void initData0 (Data< T > *field, typename Data< T >::InitData &res, const T &value, const char *name, const char *help, bool isDisplayed=true, bool isReadOnly=false)
 Helper method used by initData() More...
 

Additional Inherited Members

- Static Public Member Functions inherited from sofa::core::objectmodel::BaseObject
template<class T >
static bool canCreate (T *, BaseContext *, BaseObjectDescription *)
 Pre-construction check method called by ObjectFactory. More...
 
template<class T >
static T::SPtr create (T *, BaseContext *context, BaseObjectDescription *arg)
 Construction method called by ObjectFactory. More...
 
- Static Public Member Functions inherited from sofa::core::objectmodel::Base
static const BaseClassGetClass ()
 
template<class T >
static std::string shortName (const T *ptr=nullptr, BaseObjectDescription *=nullptr)
 
- Static Protected Member Functions inherited from sofa::core::loader::BaseLoader
static void skipToEOL (FILE *f)
 
static bool readLine (char *buf, int size, FILE *f)
 

Attribute details

◆ activeValue

Data< type::vector<int> > sofa::component::io::mesh::VoxelGridLoader::activeValue

Active data values.

◆ backgroundValue

Data< type::vector<int> > sofa::component::io::mesh::VoxelGridLoader::backgroundValue

Background values (to be ignored)

◆ bpp

int sofa::component::io::mesh::VoxelGridLoader::bpp
protected

◆ dataResolution

Data< Vec3i > sofa::component::io::mesh::VoxelGridLoader::dataResolution

Resolution of the voxel file.

◆ generateHexa

Data<bool> sofa::component::io::mesh::VoxelGridLoader::generateHexa

Interpret voxel as either hexa or points.

◆ headerSize

Data< int > sofa::component::io::mesh::VoxelGridLoader::headerSize

Header size in bytes.

◆ idxInRegularGrid

Data< type::vector<unsigned int> > sofa::component::io::mesh::VoxelGridLoader::idxInRegularGrid

indices of the hexa in the grid.

◆ image

helper::io::Image* sofa::component::io::mesh::VoxelGridLoader::image
protected

◆ roi

Data< Vec6i > sofa::component::io::mesh::VoxelGridLoader::roi

Region of interest (xmin, ymin, zmin, xmax, ymax, zmax)

◆ segmentation

helper::io::Image* sofa::component::io::mesh::VoxelGridLoader::segmentation
protected

◆ segmentationHeaderSize

Data< int > sofa::component::io::mesh::VoxelGridLoader::segmentationHeaderSize

Header size in bytes.

◆ voxelSize

Data< type::Vec3 > sofa::component::io::mesh::VoxelGridLoader::voxelSize

Dimension of one voxel.

Constructor details

◆ VoxelGridLoader()

sofa::component::io::mesh::VoxelGridLoader::VoxelGridLoader ( )
protected

◆ ~VoxelGridLoader()

sofa::component::io::mesh::VoxelGridLoader::~VoxelGridLoader ( )
overrideprotected

Function details

◆ addActiveDataValue()

void sofa::component::io::mesh::VoxelGridLoader::addActiveDataValue ( const int  value)

◆ addBackgroundValue()

void sofa::component::io::mesh::VoxelGridLoader::addBackgroundValue ( const int  value)

◆ canLoad()

bool sofa::component::io::mesh::VoxelGridLoader::canLoad ( )
overridevirtual

Reimplemented from sofa::core::loader::BaseLoader.

◆ clear()

void sofa::component::io::mesh::VoxelGridLoader::clear ( )
virtual

◆ createSegmentation3DTexture()

void sofa::component::io::mesh::VoxelGridLoader::createSegmentation3DTexture ( unsigned char **  textureData,
int &  width,
int &  height,
int &  depth 
)
overridevirtual

◆ getActiveDataValue()

int sofa::component::io::mesh::VoxelGridLoader::getActiveDataValue ( const unsigned int  idx = 0) const

◆ getBackgroundValue()

int sofa::component::io::mesh::VoxelGridLoader::getBackgroundValue ( const unsigned int  idx = 0) const

◆ getData()

unsigned char * sofa::component::io::mesh::VoxelGridLoader::getData ( )
overridevirtual

◆ getDataSize()

int sofa::component::io::mesh::VoxelGridLoader::getDataSize ( ) const
overridevirtual

◆ getHexaIndicesInGrid()

type::vector< unsigned int > sofa::component::io::mesh::VoxelGridLoader::getHexaIndicesInGrid ( ) const
overridevirtual

◆ getResolution()

void sofa::component::io::mesh::VoxelGridLoader::getResolution ( Vec3i res) const

◆ getROI()

VoxelGridLoader::Vec6i sofa::component::io::mesh::VoxelGridLoader::getROI ( ) const
overridevirtual

◆ getSegmentID()

unsigned char * sofa::component::io::mesh::VoxelGridLoader::getSegmentID ( )
overridevirtual

◆ getVoxelSize()

type::Vec3 sofa::component::io::mesh::VoxelGridLoader::getVoxelSize ( ) const
overridevirtual

◆ init()

void sofa::component::io::mesh::VoxelGridLoader::init ( void  )
overridevirtual

Initialization method called at graph creation and modification, during top-down traversal.

Reimplemented from sofa::core::objectmodel::BaseObject.

◆ load()

bool sofa::component::io::mesh::VoxelGridLoader::load ( )
overridevirtual

◆ reinit()

void sofa::component::io::mesh::VoxelGridLoader::reinit ( )
overridevirtual

Update method called when variables used in precomputation are modified.

Reimplemented from sofa::core::objectmodel::BaseObject.

◆ setVoxelSize()

void sofa::component::io::mesh::VoxelGridLoader::setVoxelSize ( const type::Vec3  vSize)

◆ SOFA_CLASS()

sofa::component::io::mesh::VoxelGridLoader::SOFA_CLASS ( VoxelGridLoader  ,
VoxelLoader   
)