SOFA plugin: image  master
Open source framework for multi-physics simuation
SofaImage.API.Image Class Reference

Detailed Description

 This class proposes a high-level API to build images. It support multiple meshes rasterization.

Classes

class  Mesh
 

Public Attributes

 imageType
 
 prefix
 
 node
 
 name
 
 meshes
 
 meshSeq
 
 image
 
 viewer
 
 exporter
 

Public Member Functions

def getImagePath (self)
 
def template (self)
 
def addContainer (self, filename=None, directory="", name='')
 
def fromTransferFunction (self, inputImage, param)
 
def fromImages (self, images, overlap="1")
 
def addExporter (self, filename=None, directory="")
 
def addMeshLoader (self, meshFile, value, insideValue=None, closingValue=None, roiIndices=list(), roiValue=list(), name=None, offset=[0, 0, 0, 0, 0, 0, 1], scale=[1, 1, 1])
 
def addExternMesh (self, externMesh, value, insideValue=None, closingValue=None, roiIndices=list(), roiValue=list(), name=None)
 
def addMeshVisual (self, meshName=None, color=None)
 
def addClosingVisual (self, meshName=None, color=None)
 
def addAllMeshVisual (self, color=None)
 
def addMeshToImage (self, voxelSize)
 
def addViewer (self)
 
def getFilename (self, filename=None, directory="")
 
def createTransferFunction (self, parentNode, name, param, imageType="ImageR")
 

Attribute details

◆ exporter

SofaImage.API.Image.exporter

◆ image

SofaImage.API.Image.image

◆ imageType

SofaImage.API.Image.imageType

◆ meshes

SofaImage.API.Image.meshes

◆ meshSeq

SofaImage.API.Image.meshSeq

◆ name

SofaImage.API.Image.name

◆ node

SofaImage.API.Image.node

◆ prefix

SofaImage.API.Image.prefix

◆ viewer

SofaImage.API.Image.viewer

Function details

◆ addAllMeshVisual()

def SofaImage.API.Image.addAllMeshVisual (   self,
  color = None 
)

◆ addClosingVisual()

def SofaImage.API.Image.addClosingVisual (   self,
  meshName = None,
  color = None 
)

◆ addContainer()

def SofaImage.API.Image.addContainer (   self,
  filename = None,
  directory = "",
  name = '' 
)

◆ addExporter()

def SofaImage.API.Image.addExporter (   self,
  filename = None,
  directory = "" 
)

◆ addExternMesh()

def SofaImage.API.Image.addExternMesh (   self,
  externMesh,
  value,
  insideValue = None,
  closingValue = None,
  roiIndices = list(),
  roiValue = list(),
  name = None 
)

◆ addMeshLoader()

def SofaImage.API.Image.addMeshLoader (   self,
  meshFile,
  value,
  insideValue = None,
  closingValue = None,
  roiIndices = list(),
  roiValue = list(),
  name = None,
  offset = [0,0,0,0,0,0,1],
  scale = [1,1,1] 
)

◆ addMeshToImage()

def SofaImage.API.Image.addMeshToImage (   self,
  voxelSize 
)

◆ addMeshVisual()

def SofaImage.API.Image.addMeshVisual (   self,
  meshName = None,
  color = None 
)

◆ addViewer()

def SofaImage.API.Image.addViewer (   self)

◆ createTransferFunction()

def SofaImage.API.Image.createTransferFunction (   self,
  parentNode,
  name,
  param,
  imageType = "ImageR" 
)
 Apply a TransferFunction component applied to this image
Create an output image in parentNode to store the the result
returns the corresponding SofaImage.API.Image

◆ fromImages()

def SofaImage.API.Image.fromImages (   self,
  images,
  overlap = "1" 
)
 Merge the input regular images using the MergeImagesIntoBranching component, returns the corresponding BranchingImage.API.Image

◆ fromTransferFunction()

def SofaImage.API.Image.fromTransferFunction (   self,
  inputImage,
  param 
)
 create by applying TransferFunction to input image
    note: using a different name than container allows inplace use of this function

◆ getFilename()

def SofaImage.API.Image.getFilename (   self,
  filename = None,
  directory = "" 
)

◆ getImagePath()

def SofaImage.API.Image.getImagePath (   self)

◆ template()

def SofaImage.API.Image.template (   self)