List Of Methods

This page describes the methods that should be used to access the data stored in the *.gradematerial file used to define a non-homogeneous material.

As the *.gradedmaterial is a binary file, you must use specific methods to access its content and retrieve its data. Make sure to use the 3.10.12 version of IronPython or Python language to write your scripts.

Basic Methods

Name Description Syntax
OpenFile Open the file and fill the data model

GradedIndexMaterialFile.OpenFile(Optis::IO::Path)

  • Optis::IO::Path : path and filename

    Should end by .gradedmaterial
SaveFile Save the file from the data model

object.SaveFile(BSTR bstrFileName) as Boolean

  • Object: Graded Material File

  • bstrFileName: path and filename

    Should end by .gradedmaterial
GetDataModel Get the graded index material file data model Optis::DM::DGradedIndexMaterialFile=GetDataModel()
SetDataModel Set the graded index material file data model GradedIndexMaterialFile.SetDataModel(Optis::DM::DGradedIndexMaterialFile)

Refractive Index

Name Description Syntax
GetRefIndSizeX Get the dimension in mm along X direction for refractive index data double GradedMaterialFile.GetRefIndSizeX()
GetRefIndSizeY Get the dimension in mm along Y direction for refractive index data double GradedMaterialFile.GetRefIndSizeY()
GetRefIndSizeZ Get the dimension in mm along Z direction for refractive index data double GradedMaterialFile.GetRefIndSizeZ()
GetRefIndSamplingX Get the sampling value along X direction for refractive index data uint GradedMaterialFile.GetRefIndSamplingX()
GetRefIndSamplingY Get the sampling value along Y direction for refractive index data uint GradedMaterialFile.GetRefIndSamplingY()
GetRefIndSamplingZ Get the sampling value along Z direction for refractive index data uint GradedMaterialFile.GetRefIndSamplingZ()
GetRefIndNbSamples Return the number of samples in the file for refractive index data uint GradedMaterialFile.GetRefIndNbSamples()
GetRefIndTable Get the refractive index table of a specific sample for refractive index data

Optis::Table<double, 3>=GetRefIndTable(uiSample)

  • Optis::Table<double, 3>: refractive index table
  • uiSample: index of the sample
GetRefInd Get the refractive index value for a given sample

double GradedMaterialFile.GetRefInd(uiSample, uiX, uiY, uiZ)

  • uiSample: index of the sample
  • uiX uiY uiZ: index table along X, Y, Z directions
GetRefIndWavelength Get the wavelength of a specific sample for refractive index data

double GradedMaterialFile.GetRefIndWavelength(uiSample)

  • uiSample: index of the sample
GetRefIndWavelengthsList Get the list of wavelengths for refractive index data

Optis::Vector<double>=GradedMaterialFile.GetRefIndWavelengthList()

  • Optis::Vector<double>: list of wavelengths

Absorption

Name Description Syntax
GetAbsorptionSizeX Get the dimension in mm along X direction for absorption data double GradedMaterialFile.GetAbsorptionSizeX()
GetAbsorptionSizeY Get the dimension in mm along Y direction for absorption data double GradedMaterialFile.GetAbsorptionSizeY()
GetAbsorptionSizeZ Get the dimension in mm along Z direction for absorption data double GradedMaterialFile.GetAbsorptionSizeZ()
GetAbsorptionSamplingX Get the sampling value along X direction for absorption data uint GradedMaterialFile.GetAbsorptionSamplingX()
GetAbsorptionSamplingY Get the sampling value along Y direction for absorption data uint GradedMaterialFile.GetAbsorptionSamplingY()
GetAbsorptionSamplingZ Get the sampling value along Z direction for absorption data uint GradedMaterialFile.GetAbsorptionSamplingZ()
GetAbsorptionNbSamples Return the number of samples in the file for absorption data uint GradedMaterialFile.GetAbsorptionNbSamples()
GetAbsorptionTable Get the absorption table of a specific sample for absorption data

Optis::Table<double, 3>=GetAbsorptionTable(uiSample)

  • Optis::Table<double, 3>: refractive index table
  • uiSample: index of the sample
GetAbsorption Get the absorption value for a given sample

double GradedMaterialFile.GetAbsorption(uiSample, uiX, uiY, uiZ)

  • uiSample: index of the sample
  • uiX uiY uiZ: index table along X, Y, Z directions
GetAbsorptionWavelength Get the wavelength of a specific sample for absorption data

double GradedMaterialFile.GetAbsorptionWavelength(uiSample)

  • uiSample: index of the sample
GetAbsorptionWavelengthsList Get the list of wavelengths for absorption data

Optis::Vector<double>=GradedMaterialFile.GetAbsorptionWavelengthList()

  • Optis::Vector<double>: list of wavelengths