libCZI::IDimensionChannelSPIMIlluminationSettings Class Reference

The SPIM illumination settings. More...

#include <libCZI_Metadata2.h>

Public Member Functions
virtual bool	TryGetNALightSheet (double *naLightSheet)=0
virtual bool	TryGetBeamType (DimensionChannelSPIMIlluminationSettingsBeamType *beamType)=0
virtual bool	TryGetCylinderLensRef (std::wstring *cylinderLensRef)=0
virtual std::shared_ptr< IInstrumentObjectiveSettings >	GetIlluminationObjectiveSettings ()=0
virtual std::shared_ptr< ISPIMIlluminationResonanceScannerSettings >	GetResonanceScannerSettings ()=0
virtual std::shared_ptr< ISPIMIlluminationGalvoScannerSettings >	GetGalvoScannerSettings ()=0

Detailed Description

The SPIM illumination settings.

Member Function Documentation

GetGalvoScannerSettings()

virtual std::shared_ptr<ISPIMIlluminationGalvoScannerSettings> libCZI::IDimensionChannelSPIMIlluminationSettings::GetGalvoScannerSettings ( )

pure virtual

Gets the galvo scanner settings

Returns

The galvo scanner settings if available, otherwise an empty pointer.

GetIlluminationObjectiveSettings()

virtual std::shared_ptr<IInstrumentObjectiveSettings> libCZI::IDimensionChannelSPIMIlluminationSettings::GetIlluminationObjectiveSettings ( )

pure virtual

Gets the illumination objective settings.

Returns

The illumination objective settings if available, otherwise an empty pointer.

GetResonanceScannerSettings()

virtual std::shared_ptr<ISPIMIlluminationResonanceScannerSettings> libCZI::IDimensionChannelSPIMIlluminationSettings::GetResonanceScannerSettings ( )

pure virtual

Gets the resonance scanner settings.

Returns

The resonance scanner settings if available, otherwise an empty pointer.

TryGetBeamType()

virtual bool libCZI::IDimensionChannelSPIMIlluminationSettings::TryGetBeamType ( DimensionChannelSPIMIlluminationSettingsBeamType *  beamType )

pure virtual

Try to get the beam type.

Parameters

[in,out]

beamType

If non-null and successful, the type of the beam is placed here.

Returns

{bool} True if it succeeds, false if it fails.

TryGetCylinderLensRef()

virtual bool libCZI::IDimensionChannelSPIMIlluminationSettings::TryGetCylinderLensRef ( std::wstring *  cylinderLensRef )

pure virtual

Try to get reference to the cylinder lens.

Parameters

[in,out]

cylinderLensRef

If non-null and successful, the reference to the cylinder lens is placed here.

Returns

{bool} True if it succeeds, false if it fails.

TryGetNALightSheet()

virtual bool libCZI::IDimensionChannelSPIMIlluminationSettings::TryGetNALightSheet ( double *  naLightSheet )

pure virtual

Try to get the numerical aperture of the light sheet.

Parameters

[in,out]

naLightSheet

If non-null and successful, the numerical aperture of the light sheet is placed here.

Returns

{bool} True if it succeeds, false if it fails.

---

The documentation for this class was generated from the following file:

• libCZI/libCZI_Metadata2.h