Scanner Members
The Scanner type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
|
BeginGetProfile()()()() |
Send a request to the scanner to start the a profile download. This can be used to
parallelize the transfer of data from multiple scanners. This API must be followed
by the EndGetProfile()()()() method call or the scanner communications stream will
be corrupted.
|
|
|
BeginGetProfile(Int32) |
Send a request to the scanner to start the a profile download. This can be used to
parallelize the transfer of data from multiple scanners. This API must be followed
by the EndGetProfile()()()() method call or the scanner communications stream will
be corrupted.
Remarks |
|
|
BeginGetQueuedProfiles()()()() |
Send a request to the scanner to start the profile download. This can be used to
parallelize the transfer of data from multiple scanners. This API must be followed
by the EndGetQueuedProfiles() method call or the scanner communications stream will
be corrupted.
|
|
|
BeginGetQueuedProfiles(Int32) |
Send a request to the scanner to start the profile download. This can be used to
parallelize the transfer of data from multiple scanners. This method must be followed
by the EndGetQueuedProfiles() method call or the scanner communications stream will
be corrupted.
|
|
Connect(IPAddress) |
Connect to a JoeScan scan head at the specified IP address
|
|
|
Connect(IPAddress, Int16) |
Connect to a JoeScan scan head by specifying the base IP address and cable ID.
|
|
|
Connect(IPAddress, array<Int16>[]()[][]) |
Connect to a JoeScan scan head by specifying the base IP address and an array of cable IDs.
|
|
|
Dispose()()()() |
Dispose the scanner object.
|
|
|
EndGetProfile |
Complete the BeginGetProfile call and retrieve the profile. This method must be proceded
by a call to BeginGetProfile()()()() or BeginGetProfile()()()()
|
|
|
EndGetQueuedProfiles |
Complete the GetQueuedProfiles call and retrieve the profiles. This method must be proceded
by a call to BeginGetQueuedProfiles()()()() or BeginGetQueuedProfiles()()()()
|
|
|
EnterEncoderSyncMode |
Begin running in encoder synchronized scan mode.
|
|
|
EnterPulseSyncMode |
Begin running in pulse synchronized scan mode
|
|
|
EnterTimedSyncMode |
Begin running in time synchronized scan mode.
|
|
|
Exit | |
|
|
ExitSyncMode |
Exit synchronized scanning mode (both time and encoder modes).
|
|
|
GetDiagnosticImageScan |
Retrieve an image of the laser exposure and the corresponding scan, while providing custom exposure times.
This function requires firmware revision 13817 and higher.
|
|
|
GetDiagnosticScan |
Request a raw, untransformed scan from the scanner while directly specifying the laser and camera exposure
times. This function requires firmware revision 13817 and higher.
|
|
|
GetImage |
Request a camera image from the scanner. This can be useful when debugging issues where the scanner
is encountering unexpected interference or unable to see the laser due to objects blocking the view
of the scanner.
|
|
|
GetLaserImage(Int32, ScannerImage%, RawScan%) |
Retrieve an image of the laser exposure and the corresponding scan.
|
|
|
GetLaserImage(ScannerImage%, RawScan%) |
Retrieve an image of the laser exposure and the corresponding scan.
|
|
|
GetOldCalibrationValues |
Get an array of previous calibration Values from the head
|
|
|
GetParameters |
Retrieve the parameters file from the scanner.
|
|
|
GetProfile()()()() |
Request a profile, including transformed data.
|
|
|
GetProfile(Int32) |
Request a profile, including transformed data.
|
|
|
GetQueuedProfiles()()()() |
Retrieve the queued profiles from the scanner when running in synchronized scanning mode.
|
|
|
GetQueuedProfiles(Int32) |
Retrieve the queued profiles from the scanner when running in synchronized scanning mode.
|
|
|
GetScan()()()() |
Request a raw, untransformed scan from the scanner with default laser 0.
|
|
|
GetScan(UInt32) |
Request a raw, untransformed scan from the scanner.
|
|
|
GetStatusDescription |
Get a human readable description for a status value index. See GetStatusValues()()()() for more information.
|
|
|
GetStatusValues |
Get an array of status values supported by this head.
|
|
|
InitializePerformanceCounters |
Install/Reinstall the performance counters for this class library.
|
|
|
OverrideLaserAutoexposure |
Override the laser autoexposure parameters from param.dat. The values will be lost if a new param.dat is loaded, or if
the scanner is power-cycled.
|
|
|
OverrideScanWindow |
Programmatically override the scan window settings from the param.dat file.
|
|
|
OverrideSyncSettings |
Programmatically override the sync scanning parameters from the param.dat file. Values will be lost if a new param.dat file is loaded, or if
the scanner is power-cycled. Must be called on each scanner whose parameters are to be overridden.
|
|
|
SetAlternatingExposure |
Set the alternating exposure parameters. Only works in sync mode. Settings are lost when exiting sync mode and must be resent after re-entering syncmode.
|
|
|
SetEncoder |
Reset the encoder count.
|
|
|
SetOrientation |
Sends a position calibration for the selected laser to the scanner.
|
|
|
SetParameters |
Send a parameter file to the scanner.
|
|
|
StartPulseMaster |
Tell the scanner to generate a pulse train on Start Scan I/O
|
|
|
StopPulses |
Stop the pulse train, but the PulseMaster scanner will still drive a constant value to the Start Scan output.
|
Properties
| Name | Description | |
|---|---|---|
|
CableID |
The scanner cable ID
|
|
|
FpgaVersion |
The version of the FPGA program on the scanner
|
|
|
InchesPerPulse |
Get the InchesPerPulse value (encoder scale used to calculate the profile Z component).
|
|
|
IPAddress |
Get the IP address used to connect to the scanner.
|
|
|
LaserCount |
The number of lasers in this scanner
|
|
|
LaserUpstream |
Is the laser upstream to the direction of the belt or chain.
|
|
|
NumLasers |
Number of lasers in the scanner
|
|
|
ReceiveTimeOut |
The TCP timeout for receiving data from the scanner
|
|
|
SendTimeOut |
The TCP timeout for sending data to the scanner
|
|
|
SerialNumber |
Scanner serial number
|
|
|
ServerVersion |
Version of the scan server software
|
|
|
SyncMode |
Is true if the scan head is in Sync Mode.
|
|
|
WindowBottom |
Bottom window bound of the scanner.
|
|
|
WindowLeft |
Left window bound of the scanner
|
|
|
WindowRight |
Right window bound of the scanner
|
|
|
WindowTop |
Top window bound of the scanner.
|