Member Functions

virtual Float64 mi::​neuraylib::​ILightprofile::get_candela_multiplier() const [pure virtual]

Returns the normalization factor. All data is normalized such that the maximum is 1.0. The values returned by methods like get_data() need to be multiplied by this normalization factor to retrieve the true value. Returns 0 after default construction.

virtual const Float32* mi::​neuraylib::​ILightprofile::get_data() const [pure virtual]

Returns the normalized data of the entire grid.

See also:

get_candela_multiplier()

Returns

A pointer to the normalized data for all vertices of the grid. The data values are stored as array in column-major order (where all elements of a column have the same phi value). Returns NULL after default construction.

virtual Float32 mi::​neuraylib::​ILightprofile::get_data( Uint32 index_phi, Uint32 index_theta) const [pure virtual]

Returns the normalized data for a grid vertex.

See also:

get_candela_multiplier(), sample()

Parameters

index_phi

Index in phi-direction of the vertex.

index_theta

Index in theta-direction of the vertex.

Returns

The normalized data for the grid point, or 0 in case of errors or after default construction.

virtual Lightprofile_degree mi::​neuraylib::​ILightprofile::get_degree() const [pure virtual]

Returns the interpolation degree that was used to interpolate the grid data, or mi::neuraylib::LIGHTPROFILE_HERMITE_BASE_1 after default construction.

virtual const char* mi::​neuraylib::​ILightprofile::get_filename() const [pure virtual]

Returns the resolved file name of the file containing the light profile. The method returns NULL if there is no file associated with the light profile, e.g., after default construction or failures to resolve the file name passed to reset_file().

See also:

get_original_filename()

virtual Uint32 mi::​neuraylib::​ILightprofile::get_flags() const [pure virtual]

Returns flags that were used to interpret the light profile data in the file, or mi::neuraylib::LIGHTPROFILE_COUNTER_CLOCKWISE after default construction.

See also:

mi::neuraylib::Lightprofile_flags.

virtual const char* mi::​neuraylib::​ILightprofile::get_original_filename() const [pure virtual]

Returns the unresolved file name as passed to reset_file(). The method returns NULL after default construction.

See also:

get_filename()

virtual Float32 mi::​neuraylib::​ILightprofile::get_phi( Uint32 index) const [pure virtual]

Returns the index -th phi value. Note that the grid is an equidistant grid, i.e., the distance between subsequent phi values is always the same. If index is out of bounds or after default construction, 0 is returned.

virtual Uint32 mi::​neuraylib::​ILightprofile::get_resolution_phi() const [pure virtual]

Returns the resolution of the grid in phi-direction, or 0 after default construction.

virtual Uint32 mi::​neuraylib::​ILightprofile::get_resolution_theta() const [pure virtual]

Returns the resolution of the grid in theta-direction, or 0 after default construction.

virtual Float32 mi::​neuraylib::​ILightprofile::get_theta( Uint32 index) const [pure virtual]

Returns the index -th theta value. Note that the grid is an equidistant grid, i.e., the distance between subsequent theta values is always the same. If index is out of bounds or after default construction, 0 is returned.

virtual Sint32 mi::​neuraylib::​ILightprofile::reset_file( const char* filename, Uint32 resolution_phi = 0, Uint32 resolution_theta = 0, Lightprofile_degree degree = LIGHTPROFILE_HERMITE_BASE_1, Uint32 flags = LIGHTPROFILE_COUNTER_CLOCKWISE) [pure virtual]

Sets the light profile to a file identified by filename.

See also:

mi::neuraylib::IMdl_factory::create_light_profile() for a way to create a light profile based on an MDL file path instead of a filename.

Parameters

filename

The new file containing the light profile data.

resolution_phi

The desired resolution of the equidistant grid in phi-direction. The special value 0 leaves the choice of a suitable resolution to the implementation. Currently, the implementation behaves as follows: If the angles in phi-direction are already equidistant, the resolution in the file itself (after unfolding of symmetries) is kept unchanged. If the angles in phi-direction are not equidistant, a suitable resolution that maintains the angles given in the file is chosen. If that fails, a fixed resolution is chosen.

resolution_theta

The desired resolution of the equidistant grid in theta-direction. The special value 0 leaves the choice of a suitable resolution to the implementation. Currently, the implementation behaves as follows: If the angles in theta-direction are already equidistant, the resolution in the file itself (after unfolding of symmetries) is kept unchanged. If the angles in theta-direction are not equidistant, a suitable resolution that maintains the angles given in the file is chosen. If that fails, a fixed resolution is chosen.

degree

The interpolation method to use.

flags

Flags to be used when interpreting the file data, see mi::neuraylib::Lightprofile_flags for details.

Returns

• 0: Success.
• -1: Invalid parameters (NULL pointer).
• -3: Invalid filename extension (only .ies is supported).
• -4: Failure to resolve the given filename, e.g., the file does not exist.
• -5: Failure to open the resolved file.
• -7: File format error.
• -13: flags is invalid (exactly one of mi::neuraylib::LIGHTPROFILE_CLOCKWISE or mi::neuraylib::LIGHTPROFILE_COUNTER_CLOCKWISE must be set).
• -14: degree is invalid. set).
• -15: resolution_phi or resolution_theta is invalid (must not be 1).

virtual Sint32 mi::​neuraylib::​ILightprofile::reset_reader( IReader* reader, Uint32 resolution_phi = 0, Uint32 resolution_theta = 0, Lightprofile_degree degree = LIGHTPROFILE_HERMITE_BASE_1, Uint32 flags = LIGHTPROFILE_COUNTER_CLOCKWISE) [pure virtual]

Sets the light profile to the data provided by a reader.

Parameters

reader

The reader that provides the data for the BSDF measurement in .ies format.

resolution_phi

The desired resolution of the equidistant grid in phi-direction. The special value 0 leaves the choice of a suitable resolution to the implementation. Currently, the implementation behaves as follows: If the angles in phi-direction are already equidistant, the resolution in the file itself (after unfolding of symmetries) is kept unchanged. If the angles in phi-direction are not equidistant, a suitable resolution that maintains the angles given in the file is chosen. If that fails, a fixed resolution is chosen.

resolution_theta

The desired resolution of the equidistant grid in theta-direction. The special value 0 leaves the choice of a suitable resolution to the implementation. Currently, the implementation behaves as follows: If the angles in theta-direction are already equidistant, the resolution in the file itself (after unfolding of symmetries) is kept unchanged. If the angles in theta-direction are not equidistant, a suitable resolution that maintains the angles given in the file is chosen. If that fails, a fixed resolution is chosen.

degree

The interpolation method to use.

flags

Flags to be used when interpreting the data, see mi::neuraylib::Lightprofile_flags for details.

Returns

• 0: Success.
• -1: Invalid parameters (NULL pointer).
• -7: File format error.
• -13: flags is invalid (exactly one of mi::neuraylib::LIGHTPROFILE_CLOCKWISE or mi::neuraylib::LIGHTPROFILE_COUNTER_CLOCKWISE must be set).
• -14: degree is invalid. set).
• -15: resolution_phi or resolution_theta is invalid (must not be 1).

virtual Float32 mi::​neuraylib::​ILightprofile::sample( Float32 phi, Float32 theta, bool candela) const [pure virtual]

Samples the light profile. The method computes a bi-linear interpolation of the light profile at (phi,theta) according to the resolution.

See also:

get_data()

Parameters

phi

First dimension of sample point.

theta

Second dimension of sample point.

candela

If false, normalized values are returned, otherwise true values. See get_candela_multiplier().

Returns

The computed sample value, or 0 in case of errors or after default construction.