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") | 
| SofaImage.API.Image.exporter | 
| SofaImage.API.Image.image | 
| SofaImage.API.Image.imageType | 
| SofaImage.API.Image.meshes | 
| SofaImage.API.Image.meshSeq | 
| SofaImage.API.Image.name | 
| SofaImage.API.Image.node | 
| SofaImage.API.Image.prefix | 
| SofaImage.API.Image.viewer | 
| def SofaImage.API.Image.addAllMeshVisual | ( | self, | |
| color = None | |||
| ) | 
| def SofaImage.API.Image.addClosingVisual | ( | self, | |
| meshName = None, | |||
| color = None | |||
| ) | 
| def SofaImage.API.Image.addContainer | ( | self, | |
| filename = None, | |||
| directory = "", | |||
| name = '' | |||
| ) | 
| def SofaImage.API.Image.addExporter | ( | self, | |
| filename = None, | |||
| directory = "" | |||
| ) | 
| def SofaImage.API.Image.addExternMesh | ( | self, | |
| externMesh, | |||
| value, | |||
| insideValue = None, | |||
| closingValue = None, | |||
| roiIndices = list(), | |||
| roiValue = list(), | |||
| name = None | |||
| ) | 
| 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] | |||
| ) | 
| def SofaImage.API.Image.addMeshToImage | ( | self, | |
| voxelSize | |||
| ) | 
| def SofaImage.API.Image.addMeshVisual | ( | self, | |
| meshName = None, | |||
| color = None | |||
| ) | 
| def SofaImage.API.Image.addViewer | ( | self | ) | 
| 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
| def SofaImage.API.Image.fromImages | ( | self, | |
| images, | |||
| overlap = "1" | |||
| ) | 
Merge the input regular images using the MergeImagesIntoBranching component, returns the corresponding BranchingImage.API.Image
| 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
 
| def SofaImage.API.Image.getFilename | ( | self, | |
| filename = None, | |||
| directory = "" | |||
| ) | 
| def SofaImage.API.Image.getImagePath | ( | self | ) | 
| def SofaImage.API.Image.template | ( | self | ) |