Stimulation

_SelectActiveStimOptConf, AddPattern, AddPatternEx, IsPatternDefined, ManualShot, MatchCameraROI, RemovePattern, SelectPattern, Stg_GalvoXY_GetScanningTime

AddPattern

Description

 AddPattern(
   char *StimulationDeviceName,
   char *Filename,
   char *Name
);

Stimulation pattern, specified by the Filename parameter, is added using a Name to the stimulation device specified by the StimulatioDeviceName parameter.

Parameters

char *StimulationDeviceName

ID of the stimulation device.

See List of stimulation devices.

char *Filename

Full path to the stimulation pattern image. E.g.: “C:\patterns\stimulation_pattern.bmp”

char *Name

Name of the stimulation pattern.

List of stimulation devices

The following list maps device names used in GUI to IDs used in macro functions in the StimulationDeviceName parameter.

Sim

CLxStimulationDeviceSim

AOTF

CLxAOTFStimulation

LU4A

CLxLU4AStimulation

CLxStimulationDeviceA1New

C2plus

CLxStimulationDeviceA1New

A1plus

CLxStimulationDeviceA1New

Galvano

CLxStimulationDeviceA1New

Resonant

CLxStimulationDeviceA1New

Agilent

CLxAgilentStimulation

Nikon LU-N AOTF1 TIRF_STORM1

CLxLUNStimulation_0_0

Nikon LU-NV AOTF1 TIRF_STORM1

CLxLUNBStimulation_0_0

Nikon LU-NV AOTF1 TIRF_STORM2

CLxLUNBStimulation_0_1

Nikon LU-NV AOTF1 TIRF_STORM3

CLxLUNBStimulation_0_2

Nikon LU-NV AOTF2 TIRF_STORM1

CLxLUNBStimulation_1_0

Nikon LU-NV AOTF2 TIRF_STORM2

CLxLUNBStimulation_1_1

Nikon LU-NV AOTF1 TIRF_STORM3

CLxLUNBStimulation_1_2

Nikon LU-NV Independent Fibers

CLxLUNBStimulation_Independent_Fibers

Andor Mosaic 3

CLxStimulationDeviceMosaic

Nikon DMD

CLxStimulationDeviceMosaic

Andor FRAPPA

CLxStimulationDeviceFrappa

Nikon LU-NV Nidaq AOTF1

CLxLUNB_NidaqStimulation_0

Nikon LU-NV Nidaq AOTF2

CLxLUNB_NidaqStimulation_1

Nikon LU-NV Nidaq Independent Fibers

CLxLUNB_NidaqStimulation_Independent_Fibers

Prairie Galvo XY

CLxStimulationDeviceGalvoXY

Polygon400

Mightex

AddPatternEx

Description

 AddPatternEx(
   char *StimulationDeviceName,
   char *Filename,
   char *Name,
   int  1To1,
   int  OverwriteExisting
);

Stimulation pattern, specified by the Filename parameter, is added using a Name to the stimulation device specified by the StimulatioDeviceName parameter.

Parameters

char *StimulationDeviceName

ID of the stimulation device.

See List of stimulation devices.

char *Filename

Full path to the stimulation pattern image. E.g.: “C:\patterns\stimulation_pattern.bmp”

char *Name

Name of the stimulation pattern.

int 1To1

Transforms the camera pattern directly to the DMD device.

0	disabled
1	enabled

int OverwriteExisting

Overwrites the pattern with already existing name (enabled) or creates a new pattern with a suffix (disabled).

0	disabled
1	enabled

IsPatternDefined

Description

 IsPatternDefined(
   char *StimulationDeviceName,
   char *Name
);

Returns a value whether a stimulation pattern of the specified Name is defined (1) or not (0).

Parameters

char *StimulationDeviceName

ID of the stimulation device.

See List of stimulation devices.

char *Name

Name of the stimulation pattern.

ManualShot

Description

 ManualShot(
   char *StimulationDeviceName,
   int  Enabled,
   double  StgDuration,
   char *StimulationConfigurationName
);

Executes the stimulation.

Parameters

char *StimulationDeviceName

ID of the stimulation device.

See List of stimulation devices.

int Enabled

0	Disabled.
1	Enabled.

double StgDuration

Duration of the stimulation in milliseconds.

char *StimulationConfigurationName

Specifies which group is stimulated.

MatchCameraROI

Description

 MatchCameraROI(
   char *StimulationDeviceName
);

Matches the field of view of the camera with the extent of the stimulation device.

Parameters

char *StimulationDeviceName

ID of the stimulation device.

See List of stimulation devices.

RemovePattern

Description

 RemovePattern(
   char *StimulationDeviceName,
   char *Name
);

Removes the specified stimulation pattern.

Parameters

char *StimulationDeviceName

ID of the stimulation device.

See List of stimulation devices.

char *Name

Name of the stimulation pattern.

char *Name

Name of the stimulation pattern.

SelectPattern

Description

 SelectPattern(
   char *StimulationDeviceName,
   char *Name
);

Selects a stimulation pattern for a stimulation device.

Parameters

char *StimulationDeviceName

ID of the stimulation device.

See List of stimulation devices.

char *Name

Name of the stimulation pattern.

Stg_GalvoXY_GetScanningTime

Description

 Stg_GalvoXY_GetScanningTime(
   char *StimulationConfigurations,
   int  NumRepeats
);

Returns the stimulation time of one or X loops for the given configuration. Double value 0 is returned when no such device was found or ROI for the Stimulation Configuration (SC) was not defined. Otherwise the function returns the time in msec of all SCs in the first parameter (comma separated) * the number of repetitions.

Parameters

char *StimulationConfigurations

Name of the Stimulation Configuration (SC), comma separated if there are more than one SC.

int NumRepeats

Number of stimulation repetitions.

_SelectActiveStimOptConf

Description

 _SelectActiveStimOptConf();

Opens the Select Stimulation Configuration dialog window used for specifying the used stimulation correction.

Stimulation🔗

Stimulation