Atik SDK
Atik SDK for Atik devices
Classes | Macros | Typedefs | Enumerations | Functions | Variables
AtikCameras.h File Reference

Atik SDK C interface header. More...

#include <stddef.h>
#include <stdbool.h>

Go to the source code of this file.

Classes

struct  ARTEMISPROPERTIES
 

Macros

#define artfn   extern
 Function declaration linkage is implicitly extern This definition and further usage has been left in for legacy purposes.
 

Typedefs

typedef int BOOL
 Typedef for non windows builds.
 
typedef void * HINSTANCE
 Typedef for non windows builds.
 
typedef void * ArtemisHandle
 

Enumerations

enum  ARTEMISERROR {
  ARTEMIS_OK = 0 , ARTEMIS_INVALID_PARAMETER , ARTEMIS_NOT_CONNECTED , ARTEMIS_NOT_IMPLEMENTED ,
  ARTEMIS_NO_RESPONSE , ARTEMIS_INVALID_FUNCTION , ARTEMIS_NOT_INITIALIZED , ARTEMIS_OPERATION_FAILED
}
 Main error enum for methods with "int" as return type. More...
 
enum  ARTEMISCOLOURTYPE { ARTEMIS_COLOUR_UNKNOWN = 0 , ARTEMIS_COLOUR_NONE , ARTEMIS_COLOUR_RGGB }
 Camera colour properties. More...
 
enum  ARTEMISPRECHARGEMODE { PRECHARGE_NONE = 0 , PRECHARGE_ICPS , PRECHARGE_FULL }
 
enum  ARTEMISCAMERASTATE {
  CAMERA_ERROR = -1 , CAMERA_IDLE = 0 , CAMERA_WAITING , CAMERA_EXPOSING ,
  CAMERA_READING , CAMERA_DOWNLOADING , CAMERA_FLUSHING
}
 
enum  ARTEMISCONNECTIONSTATE {
  CAMERA_CONNECTING = 1 , CAMERA_CONNECTED = 2 , CAMERA_CONNECT_FAILED = 3 , CAMERA_SUSPENDED = 4 ,
  CAMERA_CONNECT_UNKNOWN = 5
}
 
enum  ARTEMISPROCESSING { ARTEMIS_PROCESS_LINEARISE = 1 , ARTEMIS_PROCESS_VBE = 2 }
 
enum  ARTEMISPROPERTIESCCDFLAGS { ARTEMIS_PROPERTIES_CCDFLAGS_INTERLACED = 1 , ARTEMIS_PROPERTIES_CCDFLAGS_DUMMY = 0x7FFFFFFF }
 Index into the ccdflags value of ARTEMISPROPERTIES. More...
 
enum  ARTEMISPROPERTIESCAMERAFLAGS {
  ARTEMIS_PROPERTIES_CAMERAFLAGS_FIFO = 1 , ARTEMIS_PROPERTIES_CAMERAFLAGS_EXT_TRIGGER = 2 , ARTEMIS_PROPERTIES_CAMERAFLAGS_PREVIEW = 4 , ARTEMIS_PROPERTIES_CAMERAFLAGS_SUBSAMPLE = 8 ,
  ARTEMIS_PROPERTIES_CAMERAFLAGS_HAS_SHUTTER = 16 , ARTEMIS_PROPERTIES_CAMERAFLAGS_HAS_GUIDE_PORT = 32 , ARTEMIS_PROPERTIES_CAMERAFLAGS_HAS_GPIO = 64 , ARTEMIS_PROPERTIES_CAMERAFLAGS_HAS_WINDOW_HEATER = 128 ,
  ARTEMIS_PROPERTIES_CAMERAFLAGS_HAS_EIGHT_BIT_MODE = 256 , ARTEMIS_PROPERTIES_CAMERAFLAGS_HAS_OVERLAP_MODE = 512 , ARTEMIS_PROPERTIES_CAMERAFLAGS_HAS_FILTERWHEEL = 1024 , ARTEMIS_PROPERTIES_CAMERAFLAGS_DUMMY = 0x7FFFFFFF
}
 
enum  ARTEMISCOOLINGINFO {
  ARTEMIS_COOLING_INFO_HASCOOLING = 1 , ARTEMIS_COOLING_INFO_CONTROLLABLE = 2 , ARTEMIS_COOLING_INFO_ONOFFCOOLINGCONTROL = 4 , ARTEMIS_COOLING_INFO_POWERLEVELCONTROL = 8 ,
  ARTEMIS_COOLING_INFO_SETPOINTCONTROL = 16 , ARTEMIS_COOLING_INFO_WARMINGUP = 32 , ARTEMIS_COOLING_INFO_COOLINGON = 64 , ARTEMIS_COOLING_INFO_SETPOINTCONTROLON = 128
}
 Index into ArtemisCoolingInfo() Flags. More...
 
enum  ARTEMISEFWTYPE { ARTEMIS_EFW1 = 1 , ARTEMIS_EFW2 = 2 }
 Filter wheel type. More...
 
enum  CameraSpecificOptionsIDs {
  ID_GOPresetMode = 1 , ID_GOPresetLow = 2 , ID_GOPresetMed = 3 , ID_GOPresetHigh = 4 ,
  ID_GOCustomGain = 5 , ID_GOCustomOffset = 6 , ID_EvenIllumination = 12 , ID_PadData = 13 ,
  ID_ExposureSpeed = 14 , ID_BitSendMode = 15 , ID_FX3Version = 200 , ID_FPGAVersion = 201
}
 ID's for the camera specific options. More...
 
enum  HotPixelSensitivity { HPS_HIGH , HPS_MEDIUM , HPS_LOW }
 

Functions

artfn int ArtemisAPIVersion ()
 Get API version. This may be the same as the DLL version. More...
 
artfn int ArtemisDLLVersion ()
 Get DLL version. This may be the same as the API version. More...
 
artfn BOOL ArtemisIsLocalConnection ()
 Gets whether the connection to the camera is local. More...
 
artfn void ArtemisAllowDebugToConsole (bool value)
 Allows debug output to be output to standard error. More...
 
artfn void ArtemisSetDebugCallback (void(*callback)(const char *message))
 Provide a pointer to a function, which will be invoked when debug output is produced. This can be used in combination with ArtemisAllowDebugToConsole. More...
 
artfn void ArtemisSetDebugCallbackContext (void *context, void(*callback)(void *context, const char *message))
 Same as ArtemisSetDebugCallback(), but allows to pass an additional void pointer. This can be used to store a user-allocated data structure which will be passed to the callback. This pointer needs to be allocated and managed by the user. The context will never be freed by the API. More...
 
artfn void ArtemisSetFirmwareDir (const char *firmwareDir)
 Internal function used during flashing. More...
 
artfn void ArtemisSetAtikAir (const char *host, int port)
 Connect to an AtikAir instance. More...
 
artfn void ArtemisShutdown ()
 Deallocates all internal DLL structures. The SDK functions may not be called after calling this function.
 
artfn int ArtemisDeviceCount ()
 Returns the number of connected and recognised devices. The count does not include misconfigured devices (E.G. if drivers are missing). More...
 
artfn BOOL ArtemisDeviceIsPresent (int iDevice)
 Duplicate of ArtemisDevicePresent(). More...
 
artfn BOOL ArtemisDevicePresent (int iDevice)
 checks if the device at the index is connected. More...
 
artfn BOOL ArtemisDeviceInUse (int iDevice)
 Checks if the device has already been connected to. More...
 
artfn BOOL ArtemisDeviceName (int iDevice, char *pName)
 Retrieves the device's printable name. More...
 
artfn BOOL ArtemisDeviceSerial (int iDevice, char *pSerial)
 Retrieves the device's serial number. More...
 
artfn BOOL ArtemisDeviceIsCamera (int iDevice)
 Return whether the device at the specified index is a camera (and not E.G. a filter wheel device). More...
 
artfn BOOL ArtemisDeviceHasFilterWheel (int iDevice)
 Return whether the device at the specified index has a filter wheel device. More...
 
artfn BOOL ArtemisDeviceHasGuidePort (int iDevice)
 Return whether the device at the specified index has a guide port. More...
 
artfn ArtemisHandle ArtemisConnect (int iDevice)
 
artfn BOOL ArtemisIsConnected (ArtemisHandle handle)
 Returns whether the handle is currently connected to a camera. More...
 
artfn BOOL ArtemisDisconnect (ArtemisHandle handle)
 Disconnects from the device with that handle and invalidates the handle. More...
 
artfn int ArtemisRefreshDevicesCount ()
 Updates the available device count. More...
 
artfn int ArtemisCameraSerial (ArtemisHandle handle, int *flags, int *serial)
 Retrieves the serial number of the connected device. More...
 
artfn int ArtemisColourProperties (ArtemisHandle handle, ARTEMISCOLOURTYPE *colourType, int *normalOffsetX, int *normalOffsetY, int *previewOffsetX, int *previewOffsetY)
 Retrieves the colour properties of the the connected device. More...
 
artfn int ArtemisProperties (ArtemisHandle handle, struct ARTEMISPROPERTIES *pProp)
 
artfn int ArtemisCameraConnectionState (ArtemisHandle handle, ARTEMISCONNECTIONSTATE *state)
 Retrieves the camera connection state. More...
 
artfn int ArtemisBin (ArtemisHandle handle, int x, int y)
 Sets the binning for the device. This will cause the resolution of the captured image to change accordingly with the requested bin values. More...
 
artfn int ArtemisGetBin (ArtemisHandle handle, int *x, int *y)
 Gets the binning for the device. More...
 
artfn int ArtemisGetMaxBin (ArtemisHandle handle, int *x, int *y)
 Retrieves the maximum binning supported by the device. More...
 
artfn int ArtemisGetSubframe (ArtemisHandle handle, int *x, int *y, int *w, int *h)
 Retrieves the current subframing setting for the device. More...
 
artfn int ArtemisSubframe (ArtemisHandle handle, int x, int y, int w, int h)
 Set the device's subframe position and size. This is equivalent to calling ArtemisSubframePos() followed by ArtemisSubframeSize(). More...
 
artfn int ArtemisSubframePos (ArtemisHandle handle, int x, int y)
 Sets the device's subframe position. More...
 
artfn int ArtemisSubframeSize (ArtemisHandle handle, int w, int h)
 Sets the device's subframe width and height. More...
 
artfn int ArtemisSetSubSample (ArtemisHandle handle, bool bSub)
 Set whether subsampling mode is enabled on the device. More...
 
artfn BOOL ArtemisContinuousExposingModeSupported (ArtemisHandle handle)
 Retrieves whether continuous exposing is supported by the device. More...
 
artfn BOOL ArtemisGetContinuousExposingMode (ArtemisHandle handle)
 Retrieves whether continuous exposing is enabled for the device. More...
 
artfn int ArtemisSetContinuousExposingMode (ArtemisHandle handle, bool bEnable)
 Set whether continuous exposing mode is enabled. This only has an effect on supported devices. More...
 
artfn BOOL ArtemisGetDarkMode (ArtemisHandle handle)
 Retrieves whether dark mode is enabled for the device. More...
 
artfn int ArtemisSetDarkMode (ArtemisHandle handle, bool bEnable)
 Sets whether dark mode is enabled for the device. More...
 
artfn int ArtemisSetPreview (ArtemisHandle handle, bool bPrev)
 Sets whether preview mode is enabled for the device. If preview mode is enabled, the sensor is not cleared between exposures. Using preview mode, there might be more noise/glow in the resulting image. More...
 
artfn int ArtemisAutoAdjustBlackLevel (ArtemisHandle handle, bool bEnable)
 Sets whether black auto-adjustment is enabled. More...
 
artfn int ArtemisPrechargeMode (ArtemisHandle handle, int mode)
 Sets the precharge mode of the camera. Precharge applies an in-camera offset, mainly for astronomy use. More...
 
artfn int ArtemisEightBitMode (ArtemisHandle handle, bool eightbit)
 Sets whether 8-bit mode is enabled on the device. This affects the size of the returned image buffer, which by default is 16 bits per pixel. More...
 
artfn int ArtemisGetEightBitMode (ArtemisHandle handle, bool *eightbit)
 Retrieves whether 8-bit mode is enabled on the device. More...
 
artfn int ArtemisStartOverlappedExposure (ArtemisHandle handle)
 Begin an overlapped exposure. More...
 
artfn BOOL ArtemisOverlappedExposureValid (ArtemisHandle handle)
 Returns whether the overlapped exposure is still valid. More...
 
artfn int ArtemisSetOverlappedExposureTime (ArtemisHandle handle, float fSeconds)
 Set the overlapped exposure time. More...
 
artfn int ArtemisTriggeredExposure (ArtemisHandle handle, bool bAwaitTrigger)
 Sets whether the device will await a triggered exposure. More...
 
artfn int ArtemisGetProcessing (ArtemisHandle handle)
 Return which post processing flags are enabled for the device. More...
 
artfn int ArtemisSetProcessing (ArtemisHandle handle, int options)
 Sets which post processing effects are enabled for the device. More...
 
artfn int ArtemisStartExposure (ArtemisHandle handle, float seconds)
 Begin an exposure for the device, specifying a duration as floating point seconds. More...
 
artfn int ArtemisStartExposureMS (ArtemisHandle handle, int ms)
 Begin an exposure for the device, specifying a duration as milliseconds. More...
 
artfn int ArtemisAbortExposure (ArtemisHandle handle)
 Stop the current exposure for the device. This is analogous to ArtemisStopExposure(). More...
 
artfn int ArtemisStopExposure (ArtemisHandle handle)
 Stop the current exposure for the device. This is analogous to ArtemisAbortExposure(). More...
 
artfn BOOL ArtemisImageReady (ArtemisHandle handle)
 Returns whether the image has been fully downloaded and is ready to access. This method can be polled until it returns TRUE, after which ArtemisGetImageData() and ArtemisImageBuffer() can be called to get the results of the exposure. It is recommended to add a delay in between polling (E.G. 10 milliseconds). More...
 
artfn int ArtemisCameraState (ArtemisHandle handle)
 Returns the device's state as an ARTEMISCAMERASTATE enumeration. More...
 
artfn float ArtemisExposureTimeRemaining (ArtemisHandle handle)
 Returns how much time is left in the exposure as a floating point number. Note this does not include the download time. More...
 
artfn int ArtemisDownloadPercent (ArtemisHandle handle)
 Returns the download progress in percent. More...
 
artfn int ArtemisGetImageData (ArtemisHandle handle, int *x, int *y, int *w, int *h, int *binx, int *biny)
 Provides information about the latest acquired image. More...
 
artfn void * ArtemisImageBuffer (ArtemisHandle handle)
 Returns a pointer to the internal image buffer which contains the latest captured image. The buffer size can be calculated by width * height * pixel depth. More...
 
artfn float ArtemisLastExposureDuration (ArtemisHandle handle)
 Returns the duration of the last exposure as floating point number of seconds. More...
 
artfn char * ArtemisLastStartTime (ArtemisHandle handle)
 Returns a pointer to the formatted last exposure start time. The buffer is internal to the SDK and is overwritten every time this function is called. Does not include milliseconds. More...
 
artfn int ArtemisLastStartTimeMilliseconds (ArtemisHandle handle)
 Returns the last exposure start time millisecond component. More...
 
artfn int ArtemisClearVReg (ArtemisHandle handle)
 This API is for internal use. More...
 
artfn BOOL ArtemisHasFastMode (ArtemisHandle handle)
 Gets whether the device supports fast mode. More...
 
artfn BOOL ArtemisStartFastExposure (ArtemisHandle handle, int ms)
 Begins a fast mode exposure. More...
 
artfn BOOL ArtemisSetFastCallback (ArtemisHandle handle, void(*callback)(ArtemisHandle handle, int x, int y, int w, int h, int binx, int biny, void *imageBuffer))
 Set the callback that will be invoked when a fast mode exposure is completed. More...
 
artfn int ArtemisAmplifier (ArtemisHandle handle, bool bOn)
 Enable/disable the device's amplifier. This function is equivalent to ArtemisSetAmplifierSwitched(). More...
 
artfn BOOL ArtemisGetAmplifierSwitched (ArtemisHandle handle)
 Returns whether the amplifier is enabled. More...
 
artfn int ArtemisSetAmplifierSwitched (ArtemisHandle handle, bool bSwitched)
 Enable/disable the device's amplifier. This function is equivalent to ArtemisAmplifier(). More...
 
artfn bool ArtemisHasCameraSpecificOption (ArtemisHandle handle, unsigned short id)
 Returns whether the specified option is available. More...
 
artfn int ArtemisCameraSpecificOptionGetData (ArtemisHandle handle, unsigned short id, unsigned char *data, int dataLength, int *actualLength)
 Used to get the specified option's current value. Please check that the current camera has this option using ArtemisHasCameraSpecificOption() More...
 
artfn int ArtemisCameraSpecificOptionSetData (ArtemisHandle handle, unsigned short id, unsigned char *data, int dataLength)
 Used to set the specified option's value. Please check that the current camera has this option using ArtemisHasCameraSpecificOption() More...
 
artfn int ArtemisSetColumnRepairColumns (ArtemisHandle handle, int nColumn, unsigned short *columns)
 Set the columns on which column repair post processing is performed. More...
 
artfn int ArtemisGetColumnRepairColumns (ArtemisHandle handle, int *nColumn, unsigned short *columns)
 Get the columns on which column repair post processing is performed. More...
 
artfn int ArtemisClearColumnRepairColumns (ArtemisHandle handle)
 Remove all column repair processing set previously. More...
 
artfn int ArtemisSetColumnRepairFixColumns (ArtemisHandle handle, bool value)
 Sets whether column repair is enabled. More...
 
artfn int ArtemisGetColumnRepairFixColumns (ArtemisHandle handle, bool *value)
 Retrieves whether column repair is enabled or not. More...
 
artfn int ArtemisGetColumnRepairCanFixColumns (ArtemisHandle handle, bool *value)
 Retrieves whether column repair can be enabled. More...
 
artfn int ArtemisCanInteractWithEEPROM (ArtemisHandle handle, bool *canInteract)
 Retrieves whether the EEPROM can be interacted with. This API is for internal use. More...
 
artfn int ArtemisWriteToEEPROM (ArtemisHandle handle, char *password, int address, int length, const unsigned char *data)
 Writes a value to the EEPROM. This API is for internal use. More...
 
artfn int ArtemisReadFromEEPROM (ArtemisHandle handle, char *password, int address, int length, unsigned char *data)
 Reads a value from the EEPROM. This API is for internal use. More...
 
artfn int ArtemisFilterWheelInfo (ArtemisHandle handle, int *numFilters, int *moving, int *currentPos, int *targetPos)
 Retrieve the state of the filter wheel. More...
 
artfn int ArtemisFilterWheelMove (ArtemisHandle handle, int targetPos)
 Move the filter wheel to the desired location. More...
 
artfn BOOL ArtemisEFWIsPresent (int i)
 Checks whether a filter wheel is present at the index. More...
 
artfn int ArtemisEFWGetDeviceDetails (int i, ARTEMISEFWTYPE *type, char *serialNumber)
 Get information on the filter wheel device at the specified index. This is the same as ArtemisEFWGetDetails(), but without connecting first. More...
 
artfn ArtemisHandle ArtemisEFWConnect (int i)
 Connect to a filter wheel device at the specified index. More...
 
artfn bool ArtemisEFWIsConnected (ArtemisHandle handle)
 Retrieves whether the handle for the filter wheel is valid. More...
 
artfn int ArtemisEFWDisconnect (ArtemisHandle handle)
 Disconnect from the filter wheel handle. More...
 
artfn int ArtemisEFWGetDetails (ArtemisHandle handle, ARTEMISEFWTYPE *type, char *serialNumber)
 Get information on the connected filter wheel device. This is the same as ArtemisEFWGetDeviceDetails(), after connecting. More...
 
artfn int ArtemisEFWNmrPosition (ArtemisHandle handle, int *nPosition)
 Gets the number of filters inside the filter wheel. More...
 
artfn int ArtemisEFWSetPosition (ArtemisHandle handle, int iPosition)
 Sets the device's filter wheel position. More...
 
artfn int ArtemisEFWGetPosition (ArtemisHandle handle, int *iPosition, bool *isMoving)
 Gets the device's filter wheel position. More...
 
artfn bool ArtemisCanUploadFirmware (ArtemisHandle handle)
 Returns whether firmware can be uploaded to the device. This API is for internal use. More...
 
artfn int ArtemisUploadFirmware (ArtemisHandle handle, char *fileName, char *password)
 Upload a new firmware on the device. This API is for internal use. More...
 
artfn int ArtemisGetGain (ArtemisHandle handle, bool isPreview, int *gain, int *offset)
 Get the currently set gain and offset for the device. Note that Horizon/ACIS cameras need to use ArtemisCameraSpecificOptionGetData() to get the gain. More...
 
artfn int ArtemisSetGain (ArtemisHandle handle, bool isPreview, int gain, int offset)
 Set the gain and offset for the device Note that Horizon/ACIS cameras need to use ArtemisCameraSpecificOptionSetData() to set the gain. More...
 
artfn int ArtemisGetGpioInformation (ArtemisHandle handle, int *lineCount, int *lineValues)
 
artfn int ArtemisSetGpioDirection (ArtemisHandle handle, int directionMask)
 
artfn int ArtemisSetGpioValues (ArtemisHandle handle, int lineValues)
 
artfn int ArtemisGuide (ArtemisHandle handle, int axis)
 
artfn int ArtemisGuidePort (ArtemisHandle handle, int nibble)
 
artfn int ArtemisPulseGuide (ArtemisHandle handle, int axis, int milli)
 
artfn int ArtemisStopGuiding (ArtemisHandle handle)
 
artfn int ArtemisStopGuidingBeforeDownload (ArtemisHandle handle, bool bEnable)
 
artfn int ArtemisAutoHotPixelRemoval (ArtemisHandle handle, bool on)
 A software based hot pixel remover with some pre defined parameters. darkFrame = false, checkForAdjacentHotPixels = false, hps = HPS_MEDIUM. More...
 
artfn int ArtemisAdvancedHotPixelRemoval (ArtemisHandle handle, bool on, bool darkFrame, bool checkForAdjacentHotPixels, HotPixelSensitivity hps)
 A software based hot pixel remover with several parameters. If dakFrame is true this function will block for 30 seconds. More...
 
artfn int ArtemisGetLensAperture (ArtemisHandle handle, int *aperture)
 Gets the current lens aperture value. More...
 
artfn int ArtemisGetLensFocus (ArtemisHandle handle, int *focus)
 Gets the current lens focus value. More...
 
artfn int ArtemisGetLensLimits (ArtemisHandle handle, int *apertureMin, int *apertureMax, int *focusMin, int *focusMax)
 Returns the lens numerical limits for the device. More...
 
artfn int ArtemisInitializeLens (ArtemisHandle handle)
 Initialise lens controls. If not called, lens control methods will return ARTEMIS_NOT_INITIALIZED. More...
 
artfn int ArtemisSetLensAperture (ArtemisHandle handle, int aperture)
 Sets the lens aperture. More...
 
artfn int ArtemisSetLensFocus (ArtemisHandle handle, int focus)
 Sets the lens focus. More...
 
artfn int ArtemisCanControlShutter (ArtemisHandle handle, bool *canControl)
 Checks whether the shutter can be opened and closed on the device. More...
 
artfn int ArtemisOpenShutter (ArtemisHandle handle)
 Opens the shutter on the device. Please call ArtemisCanControlShutter() to see if the shutter can be controlled. More...
 
artfn int ArtemisCloseShutter (ArtemisHandle handle)
 Closes the shutter on the device. Please call ArtemisCanControlShutter() to see if the shutter can be controlled. More...
 
artfn int ArtemisCanSetShutterSpeed (ArtemisHandle handle, bool *canSetShutterSpeed)
 Checks whether the shutter speed can be set on the device. More...
 
artfn int ArtemisGetShutterSpeed (ArtemisHandle handle, int *speed)
 Gets the shutter speed. More...
 
artfn int ArtemisSetShutterSpeed (ArtemisHandle handle, int speed)
 Sets the shutter speed. More...
 
artfn int ArtemisTemperatureSensorInfo (ArtemisHandle handle, int sensor, int *temperature)
 Gets temperature of the device for the specific sensor index, in hundreds of degrees centigrade. If "sensor" is set to 0, this will be set to the number of temperature sensors on the device. More...
 
artfn int ArtemisSetCooling (ArtemisHandle handle, int setpoint)
 Sets the cooling target temperature of the device. This will override ArtemisSetCoolingPower(). More...
 
artfn int ArtemisSetCoolingPower (ArtemisHandle handle, int power)
 Sets the cooling power of the cooler directly. This will override ArtemisSetCooling(). More...
 
artfn int ArtemisCoolingInfo (ArtemisHandle handle, int *flags, int *level, int *minlvl, int *maxlvl, int *setpoint)
 Retrieves information about the cooling settings for the device. More...
 
artfn int ArtemisCoolerWarmUp (ArtemisHandle handle)
 Disables active cooling for the device. On some devices, this will perform a slow ramp down of the cooler, to avoid thermal shock. More...
 
artfn int ArtemisGetWindowHeaterPower (ArtemisHandle handle, int *windowHeaterPower)
 Gets the window heater power. More...
 
artfn int ArtemisSetWindowHeaterPower (ArtemisHandle handle, int windowHeaterPower)
 Sets the window heater power. More...
 
artfn bool ArtemisLoadDLL (const char *fileName)
 Dynamically loads the Atik implementation DLL. This method is only needed if the DLL is linked dynamically. This method is part of the DLL example code. More...
 
artfn void ArtemisUnLoadDLL ()
 Unloads the Atik DLL and frees the internal DLL handle. This method is only needed if the DLL is linked dynamically. This method is part of the DLL example code. More...
 

Variables

static HINSTANCE hArtemisDLL = NULL
 DLL handle set by ArtemisLoadDLL(). This is irrelevant if you are linking at compile time.
 

Detailed Description

Atik SDK C interface header.

Typedef Documentation

◆ ArtemisHandle

typedef void* ArtemisHandle

Atik SDK handle type

See also
ArtemisConnect(), ArtemisEFWConnect()

Enumeration Type Documentation

◆ ARTEMISCAMERASTATE

◆ ARTEMISCOLOURTYPE

Camera colour properties.

Enumerator
ARTEMIS_COLOUR_UNKNOWN 

Either the device is not a camera or the colour cannot be determined.

ARTEMIS_COLOUR_NONE 

Device sensor is monochrome.

ARTEMIS_COLOUR_RGGB 

Device sensor is colour (RGGB)

◆ ARTEMISCOOLINGINFO

Index into ArtemisCoolingInfo() Flags.

See also
ArtemisCoolingInfo()
Enumerator
ARTEMIS_COOLING_INFO_HASCOOLING 

Camera can be cooled. 0= No cooling ability 1= Has cooling.

ARTEMIS_COOLING_INFO_CONTROLLABLE 

Cooling is always on or can be controlled. 0= Always on 1= Controllable.

ARTEMIS_COOLING_INFO_ONOFFCOOLINGCONTROL 

Cooling can be switched On/Off. 0= On/Off control not available 1= On/Off control available.

ARTEMIS_COOLING_INFO_POWERLEVELCONTROL 

Cooling can be set via ArtemisSetCoolingPower()

ARTEMIS_COOLING_INFO_SETPOINTCONTROL 

Cooling can be set via ArtemisSetCooling()

ARTEMIS_COOLING_INFO_WARMINGUP 

Currently warming up. 0= Normal control 1= Warming Up.

ARTEMIS_COOLING_INFO_COOLINGON 

Currently cooling. 0= Cooling off 1= Cooling on.

ARTEMIS_COOLING_INFO_SETPOINTCONTROLON 

Currently under setpoint control 0= No set point control 1= Set point control.

◆ ARTEMISEFWTYPE

Filter wheel type.

Note
An EFW3 will show as EFW2 as they use the same firmware
See also
ArtemisEFWGetDeviceDetails()

◆ ARTEMISERROR

Main error enum for methods with "int" as return type.

Enumerator
ARTEMIS_OK 

Operation successful.

ARTEMIS_INVALID_PARAMETER 

The camera handle passed is not a valid handle.

See also
ArtemisConnect()
ARTEMIS_NOT_CONNECTED 

Camera is not connected.

ARTEMIS_NOT_IMPLEMENTED 

Not impl.

ARTEMIS_NO_RESPONSE 

No response.

ARTEMIS_INVALID_FUNCTION 

Invalid function.

ARTEMIS_NOT_INITIALIZED 

Camera Not init.

ARTEMIS_OPERATION_FAILED 

Failed.

◆ ARTEMISPRECHARGEMODE

Enumerator
PRECHARGE_NONE 

Precharge ignored.

PRECHARGE_ICPS 

In-camera precharge subtraction.

PRECHARGE_FULL 

Precharge sent with image data.

◆ ARTEMISPROCESSING

Flags for ArtemisGet/SetProcessing

See also
ArtemisGetProcessing(), ArtemisSetProcessing()
Enumerator
ARTEMIS_PROCESS_LINEARISE 

compensate for JFET nonlinearity

ARTEMIS_PROCESS_VBE 

adjust for 'Venetian Blind effect'

◆ ARTEMISPROPERTIESCAMERAFLAGS

Index into the camera flags of ARTEMISPROPERTIES

See also
ARTEMISPROPERTIES
Enumerator
ARTEMIS_PROPERTIES_CAMERAFLAGS_FIFO 

Camera has readout FIFO fitted.

ARTEMIS_PROPERTIES_CAMERAFLAGS_EXT_TRIGGER 

Camera has external trigger capabilities.

ARTEMIS_PROPERTIES_CAMERAFLAGS_PREVIEW 

Camera can return preview data.

ARTEMIS_PROPERTIES_CAMERAFLAGS_SUBSAMPLE 

Camera can return subsampled data.

ARTEMIS_PROPERTIES_CAMERAFLAGS_HAS_SHUTTER 

Camera has a mechanical shutter.

ARTEMIS_PROPERTIES_CAMERAFLAGS_HAS_GUIDE_PORT 

Camera has a guide port.

ARTEMIS_PROPERTIES_CAMERAFLAGS_HAS_GPIO 

Camera has GPIO capability.

ARTEMIS_PROPERTIES_CAMERAFLAGS_HAS_WINDOW_HEATER 

Camera has a window heater.

ARTEMIS_PROPERTIES_CAMERAFLAGS_HAS_EIGHT_BIT_MODE 

Camera can download 8-bit images.

ARTEMIS_PROPERTIES_CAMERAFLAGS_HAS_OVERLAP_MODE 

Camera can overlap.

ARTEMIS_PROPERTIES_CAMERAFLAGS_HAS_FILTERWHEEL 

Camera has internal filterwheel.

ARTEMIS_PROPERTIES_CAMERAFLAGS_DUMMY 

Enum padding to 4 bytes. Not used.

◆ ARTEMISPROPERTIESCCDFLAGS

Index into the ccdflags value of ARTEMISPROPERTIES.

See also
ARTEMISPROPERTIES
Enumerator
ARTEMIS_PROPERTIES_CCDFLAGS_INTERLACED 

CCD is interlaced type.

ARTEMIS_PROPERTIES_CCDFLAGS_DUMMY 

Enum padding to 4 bytes. Not used.

◆ CameraSpecificOptionsIDs

ID's for the camera specific options.

See also
ArtemisHasCameraSpecificOption()

Function Documentation

◆ ArtemisAbortExposure()

artfn int ArtemisAbortExposure ( ArtemisHandle  handle)

Stop the current exposure for the device. This is analogous to ArtemisStopExposure().

Parameters
handlethe connected Atik device handle.
See also
ARTEMISERROR, ArtemisStartExposure(), ArtemisStartExposureMS(), ArtemisStopExposure()
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisAdvancedHotPixelRemoval()

artfn int ArtemisAdvancedHotPixelRemoval ( ArtemisHandle  handle,
bool  on,
bool  darkFrame,
bool  checkForAdjacentHotPixels,
HotPixelSensitivity  hps 
)

A software based hot pixel remover with several parameters. If dakFrame is true this function will block for 30 seconds.

Parameters
handlethe connected Atik device handle.
onturns the hot pixel removal off/on
darkFrameIf true, a 30 second dark frame will be taken. This will create a hot pixel array internally that will be used after exposure to remove hot pixels. This array will need to be regenerated on any dimension or binning change otherwise the hot pixel removal will not be applied. If this parameter is used hot pixels will not be determined during exposure only those listed in the array will be fixed. If false the internal hot pixel array will be regenarated for each exposure
checkForAdjacentHotPixelsIf true surrounding hot pixels will not be used to determine the value of the current hot pixel. This option trades time against better quality results.
hpsThis determines what is seen as a hot pixel. HPS_HIGH will see the most hot pixels.

◆ ArtemisAllowDebugToConsole()

artfn void ArtemisAllowDebugToConsole ( bool  value)

Allows debug output to be output to standard error.

Parameters
valueWhether to enable the output.
See also
ArtemisAllowDebugCallback(), ArtemisAllowDebugCallbackContext()

◆ ArtemisAmplifier()

artfn int ArtemisAmplifier ( ArtemisHandle  handle,
bool  bOn 
)

Enable/disable the device's amplifier. This function is equivalent to ArtemisSetAmplifierSwitched().

Parameters
handlethe connected Atik device handle.
bOnwhether to enable or disable the built in amplifier.
See also
ARTEMISERROR, ArtemisSetAmplifierSwitched()
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisAPIVersion()

artfn int ArtemisAPIVersion ( )

Get API version. This may be the same as the DLL version.

Returns
API version as an integer, such as: 20200904

◆ ArtemisAutoAdjustBlackLevel()

artfn int ArtemisAutoAdjustBlackLevel ( ArtemisHandle  handle,
bool  bEnable 
)

Sets whether black auto-adjustment is enabled.

Parameters
handlethe connected Atik device handle.
bEnablewhether black levels will be auto-adjusted.
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisAutoHotPixelRemoval()

artfn int ArtemisAutoHotPixelRemoval ( ArtemisHandle  handle,
bool  on 
)

A software based hot pixel remover with some pre defined parameters. darkFrame = false, checkForAdjacentHotPixels = false, hps = HPS_MEDIUM.

See also
ArtemisAdvancedHotPixelRemoval()
Parameters
handlethe connected Atik device handle.
onturns the hot pixel removal off/on

◆ ArtemisBin()

artfn int ArtemisBin ( ArtemisHandle  handle,
int  x,
int  y 
)

Sets the binning for the device. This will cause the resolution of the captured image to change accordingly with the requested bin values.

Parameters
handlethe connected Atik device handle.
xthe X binning value.
ythe Y binning value.
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisCameraConnectionState()

artfn int ArtemisCameraConnectionState ( ArtemisHandle  handle,
ARTEMISCONNECTIONSTATE *  state 
)

Retrieves the camera connection state.

Parameters
handlethe connected Atik device handle.
stateif successful, a pointer to a user provided ARTEMISCONNECTIONSTATE instance.
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisCameraSerial()

artfn int ArtemisCameraSerial ( ArtemisHandle  handle,
int *  flags,
int *  serial 
)

Retrieves the serial number of the connected device.

Parameters
handlethe connected device handle.
flagsa pointer to an integer which will be set to internal device flags.
seriala pointer to an integer which will be set to the serial number of the connected Atik device.
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure.

◆ ArtemisCameraSpecificOptionGetData()

artfn int ArtemisCameraSpecificOptionGetData ( ArtemisHandle  handle,
unsigned short  id,
unsigned char *  data,
int  dataLength,
int *  actualLength 
)

Used to get the specified option's current value. Please check that the current camera has this option using ArtemisHasCameraSpecificOption()

Parameters
handlethe connected Atik device handle.
id
data
dataLength
actualLength
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, ARTEMIS_INVALID_PARAM if the opton is not available or ARTEMISERROR on failure

◆ ArtemisCameraSpecificOptionSetData()

artfn int ArtemisCameraSpecificOptionSetData ( ArtemisHandle  handle,
unsigned short  id,
unsigned char *  data,
int  dataLength 
)

Used to set the specified option's value. Please check that the current camera has this option using ArtemisHasCameraSpecificOption()

Parameters
handlethe connected Atik device handle.
id
data
dataLength
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, ARTEMIS_INVALID_PARAM if the opton is not available or ARTEMISERROR on failure

◆ ArtemisCameraState()

artfn int ArtemisCameraState ( ArtemisHandle  handle)

Returns the device's state as an ARTEMISCAMERASTATE enumeration.

Parameters
handlethe connected device handle.
See also
ARTEMISERROR, ARTEMISCAMERASTATE
Returns
ARTEMISCAMERASTATE enumeration value.

◆ ArtemisCanControlShutter()

artfn int ArtemisCanControlShutter ( ArtemisHandle  handle,
bool *  canControl 
)

Checks whether the shutter can be opened and closed on the device.

Parameters
handlethe connected Atik device handle.
canControla pointer to a boolean which will be set to whether the shutter can be opened and closed.
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisCanInteractWithEEPROM()

artfn int ArtemisCanInteractWithEEPROM ( ArtemisHandle  handle,
bool *  canInteract 
)

Retrieves whether the EEPROM can be interacted with. This API is for internal use.

Parameters
handlethe connected Atik device handle.
canInteract
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisCanSetShutterSpeed()

artfn int ArtemisCanSetShutterSpeed ( ArtemisHandle  handle,
bool *  canSetShutterSpeed 
)

Checks whether the shutter speed can be set on the device.

Parameters
handlethe connected Atik device handle.
canSetShutterSpeeda pointer to a boolean which will be set to whether the shutter speed can be set.
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisCanUploadFirmware()

artfn bool ArtemisCanUploadFirmware ( ArtemisHandle  handle)

Returns whether firmware can be uploaded to the device. This API is for internal use.

Parameters
handlethe connected Atik device handle.
Returns
true if it can upload, false if not.

◆ ArtemisClearColumnRepairColumns()

artfn int ArtemisClearColumnRepairColumns ( ArtemisHandle  handle)

Remove all column repair processing set previously.

Parameters
handlethe connected Atik device handle.
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisClearVReg()

artfn int ArtemisClearVReg ( ArtemisHandle  handle)

This API is for internal use.

Parameters
handlethe connected Atik device handle.
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisCloseShutter()

artfn int ArtemisCloseShutter ( ArtemisHandle  handle)

Closes the shutter on the device. Please call ArtemisCanControlShutter() to see if the shutter can be controlled.

Parameters
handlethe connected Atik device handle.
See also
ARTEMISERROR, ArtemisCanControlShutter()
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisColourProperties()

artfn int ArtemisColourProperties ( ArtemisHandle  handle,
ARTEMISCOLOURTYPE colourType,
int *  normalOffsetX,
int *  normalOffsetY,
int *  previewOffsetX,
int *  previewOffsetY 
)

Retrieves the colour properties of the the connected device.

Parameters
handlethe connected device handle.
colourTypea pointer to a user provided ARTEMISCOLOURTYPE enum which will be set to an ARTEMISCOLOURTYPE value.
normalOffsetXa pointer to an integer which will be set to the normal offset over the X axis.
normalOffsetYa pointer to an integer which will be set to the normal offset over the Y axis.
previewOffsetXa pointer to an integer which will be set to the preview offset over the X axis.
previewOffsetYa pointer to an integer which will be set to the preview offset over the Y axis.
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisConnect()

artfn ArtemisHandle ArtemisConnect ( int  iDevice)

Connect to an Atik device by index and obtain an ArtemisHandle to it for further use. Use ArtemisDeviceCount to discover how many devices are available for connection.

Parameters
iDeviceDevice index. Use 0 if using a single camera.
Returns
Non-null ArtemisHandle if successful, null on failure.
See also
ArtemisDeviceCount()

◆ ArtemisContinuousExposingModeSupported()

artfn BOOL ArtemisContinuousExposingModeSupported ( ArtemisHandle  handle)

Retrieves whether continuous exposing is supported by the device.

Parameters
handlethe connected Atik device handle.
Returns
TRUE if supported, FALSE if not.

◆ ArtemisCoolerWarmUp()

artfn int ArtemisCoolerWarmUp ( ArtemisHandle  handle)

Disables active cooling for the device. On some devices, this will perform a slow ramp down of the cooler, to avoid thermal shock.

Parameters
handlethe connected Atik device handle.
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisCoolingInfo()

artfn int ArtemisCoolingInfo ( ArtemisHandle  handle,
int *  flags,
int *  level,
int *  minlvl,
int *  maxlvl,
int *  setpoint 
)

Retrieves information about the cooling settings for the device.

Parameters
handlethe connected Atik device handle.
flagsinternal flags representing the cooling state.
levelthe power level of the cooler, usually from 0 to 255.
minlvldisplays the minimum cooling power level
maxlvldisplays the maximum cooling power level
setpointthe target setpoint temperature for the camera in degrees celsius.
See also
ARTEMISERROR, ArtemisSetCoolingPower()
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisDeviceCount()

artfn int ArtemisDeviceCount ( )

Returns the number of connected and recognised devices. The count does not include misconfigured devices (E.G. if drivers are missing).

Returns
The number of connected and recognised devices.

◆ ArtemisDeviceHasFilterWheel()

artfn BOOL ArtemisDeviceHasFilterWheel ( int  iDevice)

Return whether the device at the specified index has a filter wheel device.

Parameters
iDevicethe device index.
Returns
TRUE if the device has a filter wheel device, FALSE otherwise

◆ ArtemisDeviceHasGuidePort()

artfn BOOL ArtemisDeviceHasGuidePort ( int  iDevice)

Return whether the device at the specified index has a guide port.

Parameters
iDevicethe device index.
Returns
TRUE if the device has a guide port, FALSE otherwise

◆ ArtemisDeviceInUse()

artfn BOOL ArtemisDeviceInUse ( int  iDevice)

Checks if the device has already been connected to.

Parameters
iDevicethe device index.
Returns
TRUE if the device is has a handle acquired to it, FALSE otherwise

◆ ArtemisDeviceIsCamera()

artfn BOOL ArtemisDeviceIsCamera ( int  iDevice)

Return whether the device at the specified index is a camera (and not E.G. a filter wheel device).

Parameters
iDevicethe device index.
Returns
TRUE if the device is a camera, FALSE otherwise

◆ ArtemisDeviceIsPresent()

artfn BOOL ArtemisDeviceIsPresent ( int  iDevice)

Duplicate of ArtemisDevicePresent().

Parameters
iDevicethe device index.
Returns
TRUE if the device is present, FALSE otherwise
See also
ArtemisDevicePresent()

◆ ArtemisDeviceName()

artfn BOOL ArtemisDeviceName ( int  iDevice,
char *  pName 
)

Retrieves the device's printable name.

Parameters
iDevicethe device index.
pNamea pointer to a user-allocated char array of length 100.
Returns
TRUE if the name was set successfully, FALSE if not.

◆ ArtemisDevicePresent()

artfn BOOL ArtemisDevicePresent ( int  iDevice)

checks if the device at the index is connected.

Parameters
iDevicethe device index.
Returns
TRUE if the device is present, FALSE otherwise

◆ ArtemisDeviceSerial()

artfn BOOL ArtemisDeviceSerial ( int  iDevice,
char *  pSerial 
)

Retrieves the device's serial number.

Parameters
iDevicethe device index.
pSeriala pointer to a user-allocated char array of length 100.
Returns
TRUE if the name was set successfully, FALSE if not.

◆ ArtemisDisconnect()

artfn BOOL ArtemisDisconnect ( ArtemisHandle  handle)

Disconnects from the device with that handle and invalidates the handle.

Parameters
handleThe device handle
Returns
TRUE if the handle disconnection was successful, FALSE otherwise
See also
ArtemisConnect()

◆ ArtemisDLLVersion()

artfn int ArtemisDLLVersion ( )

Get DLL version. This may be the same as the API version.

Returns
API version as an integer, such as: 20200904

◆ ArtemisDownloadPercent()

artfn int ArtemisDownloadPercent ( ArtemisHandle  handle)

Returns the download progress in percent.

Parameters
handlethe connected Atik device handle.
See also
ARTEMISERROR
Returns
the download progress in percent (0-100).

◆ ArtemisEFWConnect()

artfn ArtemisHandle ArtemisEFWConnect ( int  i)

Connect to a filter wheel device at the specified index.

Parameters
iThe index of the filter wheel device to connect to.
Returns
a valid ArtemisHandle on success, NULL on failure.

◆ ArtemisEFWDisconnect()

artfn int ArtemisEFWDisconnect ( ArtemisHandle  handle)

Disconnect from the filter wheel handle.

Parameters
handlethe connected Atik device handle.
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisEFWGetDetails()

artfn int ArtemisEFWGetDetails ( ArtemisHandle  handle,
ARTEMISEFWTYPE type,
char *  serialNumber 
)

Get information on the connected filter wheel device. This is the same as ArtemisEFWGetDeviceDetails(), after connecting.

Parameters
handlethe connected Atik device handle.
typea pointer to an ARTEMISEFWTYPE enumeration, which will be set to the type of the filter wheel device.
serialNumbera pointer to a char array of length 100, which will be set to the serial number of the filter wheel.
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisEFWGetDeviceDetails()

artfn int ArtemisEFWGetDeviceDetails ( int  i,
ARTEMISEFWTYPE type,
char *  serialNumber 
)

Get information on the filter wheel device at the specified index. This is the same as ArtemisEFWGetDetails(), but without connecting first.

Parameters
ithe index to get details for.
typea pointer to an ARTEMISEFWTYPE enumeration, which will be set to the type of the filter wheel device.
serialNumbera pointer to a char array of length 100, which will be set to the serial number of the filter wheel.
See also
ARTEMISERROR, ARTEMISEFWTYPE, ArtemisEFWGetDetails()
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisEFWGetPosition()

artfn int ArtemisEFWGetPosition ( ArtemisHandle  handle,
int *  iPosition,
bool *  isMoving 
)

Gets the device's filter wheel position.

Parameters
handlethe connected Atik device handle.
iPositionpointer to an integer which will be set to the filter wheel's current position.
isMovingpointer to a boolean which will be set to whether the filter wheel is currently moving.
Returns

◆ ArtemisEFWIsConnected()

artfn bool ArtemisEFWIsConnected ( ArtemisHandle  handle)

Retrieves whether the handle for the filter wheel is valid.

Parameters
handlethe filter wheel handle.
See also
ARTEMISERROR
Returns
true if connected, false if not.

◆ ArtemisEFWIsPresent()

artfn BOOL ArtemisEFWIsPresent ( int  i)

Checks whether a filter wheel is present at the index.

Parameters
ithe index to check.
Returns
TRUE if present, FALSE if not.

◆ ArtemisEFWNmrPosition()

artfn int ArtemisEFWNmrPosition ( ArtemisHandle  handle,
int *  nPosition 
)

Gets the number of filters inside the filter wheel.

Parameters
handlethe connected Atik device handle.
nPositiona pointer to an integer which will be set to the current filter wheel position.
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisEFWSetPosition()

artfn int ArtemisEFWSetPosition ( ArtemisHandle  handle,
int  iPosition 
)

Sets the device's filter wheel position.

Parameters
handlethe connected Atik device handle.
iPositionthe desired position
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisEightBitMode()

artfn int ArtemisEightBitMode ( ArtemisHandle  handle,
bool  eightbit 
)

Sets whether 8-bit mode is enabled on the device. This affects the size of the returned image buffer, which by default is 16 bits per pixel.

Parameters
handlethe connected Atik device handle.
eightbitwhether to enable 8-bit mode.
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisExposureTimeRemaining()

artfn float ArtemisExposureTimeRemaining ( ArtemisHandle  handle)

Returns how much time is left in the exposure as a floating point number. Note this does not include the download time.

Parameters
handlethe connected device handle.
See also
ArtemisImageReady(), ArtemisStartExposure()
Returns
the number of seconds remaining in the exposure as a floating point number.

◆ ArtemisFilterWheelInfo()

artfn int ArtemisFilterWheelInfo ( ArtemisHandle  handle,
int *  numFilters,
int *  moving,
int *  currentPos,
int *  targetPos 
)

Retrieve the state of the filter wheel.

Parameters
handlethe connected Atik device handle.
numFilterspointer to an integer which will be set to the number of filters in the filter wheel.
movingpointer to an integer which will be set to 1 if the filter wheel is moving, 0 otherwise.
currentPospointer to an integer which will be set to the current position.
targetPospointer to an integer which will be set to the target position.
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisFilterWheelMove()

artfn int ArtemisFilterWheelMove ( ArtemisHandle  handle,
int  targetPos 
)

Move the filter wheel to the desired location.

Parameters
handlethe connected Atik device handle.
targetPosthe target filter wheel position.
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisGetAmplifierSwitched()

artfn BOOL ArtemisGetAmplifierSwitched ( ArtemisHandle  handle)

Returns whether the amplifier is enabled.

Parameters
handlethe connected Atik device handle.
Returns
TRUE if the amplifier is enabled, FALSE otherwise.

◆ ArtemisGetBin()

artfn int ArtemisGetBin ( ArtemisHandle  handle,
int *  x,
int *  y 
)

Gets the binning for the device.

Parameters
handlethe connected Atik device handle.
xpointer to an integer which will be set to the X binning value.
ypointer to an integer which will be set to the Y binning value.
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisGetColumnRepairCanFixColumns()

artfn int ArtemisGetColumnRepairCanFixColumns ( ArtemisHandle  handle,
bool *  value 
)

Retrieves whether column repair can be enabled.

Parameters
handlethe connected Atik device handle.
valuea pointer to a boolean which will be set to whether the column repair can be enabled or not.
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisGetColumnRepairColumns()

artfn int ArtemisGetColumnRepairColumns ( ArtemisHandle  handle,
int *  nColumn,
unsigned short *  columns 
)

Get the columns on which column repair post processing is performed.

Parameters
handlethe connected Atik device handle.
nColumna pointer to an integer which will be set to the length of the columns array.
columnsa pointer to a user-managed array of length 1000, which will be set to the column values.
See also
ARTEMISERROR, ArtemisSetColumnRepairColumns
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisGetColumnRepairFixColumns()

artfn int ArtemisGetColumnRepairFixColumns ( ArtemisHandle  handle,
bool *  value 
)

Retrieves whether column repair is enabled or not.

Parameters
handlethe connected Atik device handle.
valuea pointer to a boolean which will be set to whether the column repair is enabled or not.
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisGetContinuousExposingMode()

artfn BOOL ArtemisGetContinuousExposingMode ( ArtemisHandle  handle)

Retrieves whether continuous exposing is enabled for the device.

Parameters
handlethe connected Atik device handle.
Returns
TRUE if continuous exposing mode is enabled, FALSE otherwise.

◆ ArtemisGetDarkMode()

artfn BOOL ArtemisGetDarkMode ( ArtemisHandle  handle)

Retrieves whether dark mode is enabled for the device.

Parameters
handlethe connected Atik device handle.
Returns
TRUE if continuous exposing mode is enabled, FALSE otherwise.

◆ ArtemisGetEightBitMode()

artfn int ArtemisGetEightBitMode ( ArtemisHandle  handle,
bool *  eightbit 
)

Retrieves whether 8-bit mode is enabled on the device.

Parameters
handlethe connected Atik device handle.
eightbitpointer to a boolean, which will be set to whether the 8-bit mode is enabled.
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisGetGain()

artfn int ArtemisGetGain ( ArtemisHandle  handle,
bool  isPreview,
int *  gain,
int *  offset 
)

Get the currently set gain and offset for the device. Note that Horizon/ACIS cameras need to use ArtemisCameraSpecificOptionGetData() to get the gain.

Parameters
handlethe connected Atik device handle.
isPreviewwhether gain will be returned for preview mode or normal mode.
gainpointer to an integer which will be set to the current gain.
offsetpointer to an integer which will be set to the current offset.
See also
ARTEMISERROR, ArtemisCameraSpecificOptionGetData()
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisGetGpioInformation()

artfn int ArtemisGetGpioInformation ( ArtemisHandle  handle,
int *  lineCount,
int *  lineValues 
)
Parameters
handlethe connected Atik device handle.
lineCount
lineValues
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisGetImageData()

artfn int ArtemisGetImageData ( ArtemisHandle  handle,
int *  x,
int *  y,
int *  w,
int *  h,
int *  binx,
int *  biny 
)

Provides information about the latest acquired image.

Parameters
handlethe connected Atik device handle.
xpointer to an integer which will be set to the subframe size in pixels, on the X axis.
ypointer to an integer which will be set to the subframe size in pixels, on the Y axis.
wpointer to an integer which will be set to the width of the image in pixels.
hpointer to an integer which will be set to the height of the image in pixels.
binxpointer to an integer which will be set to the horizontal binning used.
binypointer to an integer which will be set to the vertical binning used.
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisGetLensAperture()

artfn int ArtemisGetLensAperture ( ArtemisHandle  handle,
int *  aperture 
)

Gets the current lens aperture value.

Parameters
handlethe connected Atik device handle.
aperturea pointer to an integer which will be set to the current aperture.
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, ARTEMIS_NOT_INITIALIZED if lens not initialised, or ARTEMISERROR enumeration on failure

◆ ArtemisGetLensFocus()

artfn int ArtemisGetLensFocus ( ArtemisHandle  handle,
int *  focus 
)

Gets the current lens focus value.

Parameters
handlethe connected Atik device handle.
focusa pointer to an integer which will be set to the current lens focus value.
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, ARTEMIS_NOT_INITIALIZED if lens not initialised, or ARTEMISERROR enumeration on failure

◆ ArtemisGetLensLimits()

artfn int ArtemisGetLensLimits ( ArtemisHandle  handle,
int *  apertureMin,
int *  apertureMax,
int *  focusMin,
int *  focusMax 
)

Returns the lens numerical limits for the device.

Parameters
handlethe connected Atik device handle.
apertureMina pointer to an integer which will be set to the minimum aperture value.
apertureMaxa pointer to an integer which will be set to the maximum aperture value.
focusMina pointer to an integer which will be set to the minimum focus value.
focusMaxa pointer to an integer which will be set to the maximum focus value.
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, ARTEMIS_NOT_INITIALIZED if lens not initialised, or ARTEMISERROR enumeration on failure

◆ ArtemisGetMaxBin()

artfn int ArtemisGetMaxBin ( ArtemisHandle  handle,
int *  x,
int *  y 
)

Retrieves the maximum binning supported by the device.

Parameters
handlethe connected Atik device handle.
xpointer to an integer which will be set to the maximum supported X binning value.
ypointer to an integer which will be set to the maximum supported Y binning value.
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisGetProcessing()

artfn int ArtemisGetProcessing ( ArtemisHandle  handle)

Return which post processing flags are enabled for the device.

Parameters
handlethe connected Atik device handle.
See also
ARTEMISPROCESSING
Returns
ARTEMISPROCESSING enumeration of flags enabled for the device.

◆ ArtemisGetShutterSpeed()

artfn int ArtemisGetShutterSpeed ( ArtemisHandle  handle,
int *  speed 
)

Gets the shutter speed.

Parameters
handlethe connected Atik device handle.
speeda pointer to an integer which will be set to the speed of the shutter.
See also
ARTEMISERROR, ArtemisCanSetShutterSpeed(), ArtemisSetShutterSpeed()
Returns
ARTEMIS_OK on success, ARTEMIS_INVALID_FUNCTION if the shutter speed is not supported for the device, or ARTEMISERROR enumeration on failure

◆ ArtemisGetSubframe()

artfn int ArtemisGetSubframe ( ArtemisHandle  handle,
int *  x,
int *  y,
int *  w,
int *  h 
)

Retrieves the current subframing setting for the device.

Parameters
handlethe connected Atik device handle.
xpointer to an integer which will be set to the current subframing X offset.
ypointer to an integer which will be set to the current subframing Y offset.
wpointer to an integer which will be set to the current subframing width.
hpointer to an integer which will be set to the current subframing height.
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisGetWindowHeaterPower()

artfn int ArtemisGetWindowHeaterPower ( ArtemisHandle  handle,
int *  windowHeaterPower 
)

Gets the window heater power.

Parameters
handlethe connected Atik device handle.
windowHeaterPowera pointer to an integer, which will be set to the current window heater power, between 0 and 255.
See also
ARTEMISERROR, ArtemisSetWindowHeaterPower()
Returns
ARTEMIS_OK on success, ARTEMARTEMIS_INVALID_PARAMETER if the device does not have a window heater, or ARTEMISERROR enumeration on failure

◆ ArtemisGuide()

artfn int ArtemisGuide ( ArtemisHandle  handle,
int  axis 
)
Parameters
handlethe connected Atik device handle.
axis1= North 2= South 3= East 4= West
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisGuidePort()

artfn int ArtemisGuidePort ( ArtemisHandle  handle,
int  nibble 
)
Parameters
handlethe connected Atik device handle.
nibble0b0001= North 0b0010= South 0b0100=East 0b1000=West
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisHasCameraSpecificOption()

artfn bool ArtemisHasCameraSpecificOption ( ArtemisHandle  handle,
unsigned short  id 
)

Returns whether the specified option is available.

Parameters
handlethe connected Atik device handle.
idthe camera specific option
See also
CameraSpecificOptionsIDs
Returns
true if supported, false if not.

◆ ArtemisHasFastMode()

artfn BOOL ArtemisHasFastMode ( ArtemisHandle  handle)

Gets whether the device supports fast mode.

Parameters
handlethe connected Atik device handle.
Returns
TRUE if fast mode is supported, FALSE if not

◆ ArtemisImageBuffer()

artfn void* ArtemisImageBuffer ( ArtemisHandle  handle)

Returns a pointer to the internal image buffer which contains the latest captured image. The buffer size can be calculated by width * height * pixel depth.

Parameters
handlethe connected Atik device handle.
See also
ArtemisGetImageData()
Returns
a pointer to the internal image buffer

◆ ArtemisImageReady()

artfn BOOL ArtemisImageReady ( ArtemisHandle  handle)

Returns whether the image has been fully downloaded and is ready to access. This method can be polled until it returns TRUE, after which ArtemisGetImageData() and ArtemisImageBuffer() can be called to get the results of the exposure. It is recommended to add a delay in between polling (E.G. 10 milliseconds).

Parameters
handlethe connected Atik device handle.
Returns
TRUE if the image is ready, FALSE on failure

◆ ArtemisInitializeLens()

artfn int ArtemisInitializeLens ( ArtemisHandle  handle)

Initialise lens controls. If not called, lens control methods will return ARTEMIS_NOT_INITIALIZED.

Parameters
handlethe connected Atik device handle.
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisIsConnected()

artfn BOOL ArtemisIsConnected ( ArtemisHandle  handle)

Returns whether the handle is currently connected to a camera.

Parameters
handleThe device handle
Returns
TRUE if the handle is connected, FALSE otherwise

◆ ArtemisIsLocalConnection()

artfn BOOL ArtemisIsLocalConnection ( )

Gets whether the connection to the camera is local.

Returns
True if the connection is local (E.G. through an USB cable), false otherwise

◆ ArtemisLastExposureDuration()

artfn float ArtemisLastExposureDuration ( ArtemisHandle  handle)

Returns the duration of the last exposure as floating point number of seconds.

Parameters
handlethe connected Atik device handle.
Returns
the duration of the last exposure as floating point number of seconds.

◆ ArtemisLastStartTime()

artfn char* ArtemisLastStartTime ( ArtemisHandle  handle)

Returns a pointer to the formatted last exposure start time. The buffer is internal to the SDK and is overwritten every time this function is called. Does not include milliseconds.

Parameters
handlethe connected Atik device handle.
See also
ArtemisLastStartTimeMilliseconds()
Returns
pointer to a null terminated buffer containing the formatted time exposure was started at.

◆ ArtemisLastStartTimeMilliseconds()

artfn int ArtemisLastStartTimeMilliseconds ( ArtemisHandle  handle)

Returns the last exposure start time millisecond component.

Parameters
handlethe connected Atik device handle.
See also
ArtemisLastStartTime
Returns
millisecond component of the last exposure time.

◆ ArtemisLoadDLL()

artfn bool ArtemisLoadDLL ( const char *  fileName)

Dynamically loads the Atik implementation DLL. This method is only needed if the DLL is linked dynamically. This method is part of the DLL example code.

Parameters
fileNamethe DLL's file path
See also
ArtemisUnLoadDLL()
Returns
Returns true if the dll could be loaded, false otherwise.

◆ ArtemisOpenShutter()

artfn int ArtemisOpenShutter ( ArtemisHandle  handle)

Opens the shutter on the device. Please call ArtemisCanControlShutter() to see if the shutter can be controlled.

Parameters
handlethe connected Atik device handle.
See also
ARTEMISERROR, ArtemisCanControlShutter()
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisOverlappedExposureValid()

artfn BOOL ArtemisOverlappedExposureValid ( ArtemisHandle  handle)

Returns whether the overlapped exposure is still valid.

Parameters
handlethe connected Atik device handle.
Returns
TRUE if valid, FALSE otherwise.

◆ ArtemisPrechargeMode()

artfn int ArtemisPrechargeMode ( ArtemisHandle  handle,
int  mode 
)

Sets the precharge mode of the camera. Precharge applies an in-camera offset, mainly for astronomy use.

Parameters
handlethe connected Atik device handle.
modeARTEMISPRECHARGEMODE enumeration value
See also
ARTEMISPRECHARGEMODE, ARTEMISERROR
Returns
ARTEMIS_OK on success, other ARTEMISERROR on error

◆ ArtemisProperties()

artfn int ArtemisProperties ( ArtemisHandle  handle,
struct ARTEMISPROPERTIES pProp 
)

Gets the connected camera's physical properties.

Parameters
handleThe connected camera's handle.
pPropif successful, a pointer to a user provided ARTEMISPROPERTIES instance.
See also
ARTEMISERROR, ARTEMISPROPERTIES
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisPulseGuide()

artfn int ArtemisPulseGuide ( ArtemisHandle  handle,
int  axis,
int  milli 
)
Parameters
handlethe connected Atik device handle.
axis1= North 2= South 3= East 4= West
millinumber of milliseconds to pulse for on the selected axis
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisReadFromEEPROM()

artfn int ArtemisReadFromEEPROM ( ArtemisHandle  handle,
char *  password,
int  address,
int  length,
unsigned char *  data 
)

Reads a value from the EEPROM. This API is for internal use.

Parameters
handlethe connected Atik device handle.
passwordpassword required to interact with the device.
addressaddress of EEPROM
lengthlength of the data
datapointer to the buffer containing the data
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisRefreshDevicesCount()

artfn int ArtemisRefreshDevicesCount ( )

Updates the available device count.

Returns
See also
ArtemisDeviceCount()

◆ ArtemisSetAmplifierSwitched()

artfn int ArtemisSetAmplifierSwitched ( ArtemisHandle  handle,
bool  bSwitched 
)

Enable/disable the device's amplifier. This function is equivalent to ArtemisAmplifier().

Parameters
handlethe connected Atik device handle.
bSwitchedwhether to enable switching amplifier or not
See also
ARTEMISERROR, ArtemisAmplifier()
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisSetAtikAir()

artfn void ArtemisSetAtikAir ( const char *  host,
int  port 
)

Connect to an AtikAir instance.

Parameters
hostThe hostname or ip address of the instance, E.G. "192.168.0.1"
portthe port of the instance.

◆ ArtemisSetColumnRepairColumns()

artfn int ArtemisSetColumnRepairColumns ( ArtemisHandle  handle,
int  nColumn,
unsigned short *  columns 
)

Set the columns on which column repair post processing is performed.

Parameters
handlethe connected Atik device handle.
nColumnthe length of the array of column indices provided in columns.
columnsan array of column indices to perform repair to.
See also
ARTEMISERROR, ArtemisGetColumnRepairColumns
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisSetColumnRepairFixColumns()

artfn int ArtemisSetColumnRepairFixColumns ( ArtemisHandle  handle,
bool  value 
)

Sets whether column repair is enabled.

Parameters
handlethe connected Atik device handle.
valuewhether column repair is enabled or not.
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisSetContinuousExposingMode()

artfn int ArtemisSetContinuousExposingMode ( ArtemisHandle  handle,
bool  bEnable 
)

Set whether continuous exposing mode is enabled. This only has an effect on supported devices.

Parameters
handlethe connected Atik device handle.
bEnable
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisSetCooling()

artfn int ArtemisSetCooling ( ArtemisHandle  handle,
int  setpoint 
)

Sets the cooling target temperature of the device. This will override ArtemisSetCoolingPower().

Parameters
handlethe connected Atik device handle.
setpointthe target temperature of the device in hundreds of degrees celsius.
See also
ARTEMISERROR, ArtemisSetCoolingPower()
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisSetCoolingPower()

artfn int ArtemisSetCoolingPower ( ArtemisHandle  handle,
int  power 
)

Sets the cooling power of the cooler directly. This will override ArtemisSetCooling().

Parameters
handlethe connected Atik device handle.
powerthe power level of the cooler, from 0 to 255.
See also
ARTEMISERROR, ArtemisSetCooling()
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisSetDarkMode()

artfn int ArtemisSetDarkMode ( ArtemisHandle  handle,
bool  bEnable 
)

Sets whether dark mode is enabled for the device.

Parameters
handlethe connected Atik device handle.
bEnablewhether to enable or disable dark mode.
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisSetDebugCallback()

artfn void ArtemisSetDebugCallback ( void(*)(const char *message)  callback)

Provide a pointer to a function, which will be invoked when debug output is produced. This can be used in combination with ArtemisAllowDebugToConsole.

Parameters
callbackA function pointer to a compatible log function.
See also
ArtemisAllowDebugToConsole, ArtemisAllowDebugCallbackContext()

◆ ArtemisSetDebugCallbackContext()

artfn void ArtemisSetDebugCallbackContext ( void *  context,
void(*)(void *context, const char *message)  callback 
)

Same as ArtemisSetDebugCallback(), but allows to pass an additional void pointer. This can be used to store a user-allocated data structure which will be passed to the callback. This pointer needs to be allocated and managed by the user. The context will never be freed by the API.

Parameters
contextThe user-allocated pointer.
callbackA function pointer to a compatible log function
See also
ArtemisSetDebugCallback(), ArtemisAllowDebugToConsole()

◆ ArtemisSetFastCallback()

artfn BOOL ArtemisSetFastCallback ( ArtemisHandle  handle,
void(*)(ArtemisHandle handle, int x, int y, int w, int h, int binx, int biny, void *imageBuffer)  callback 
)

Set the callback that will be invoked when a fast mode exposure is completed.

Parameters
handlethe connected Atik device handle.
callbacka pointer to a function which will be invoked when fast mode is completed.
Returns
TRUE on success, FALSE on failure.

◆ ArtemisSetFirmwareDir()

artfn void ArtemisSetFirmwareDir ( const char *  firmwareDir)

Internal function used during flashing.

Parameters
firmwareDirThe firmware directory as null terminated string.

◆ ArtemisSetGain()

artfn int ArtemisSetGain ( ArtemisHandle  handle,
bool  isPreview,
int  gain,
int  offset 
)

Set the gain and offset for the device Note that Horizon/ACIS cameras need to use ArtemisCameraSpecificOptionSetData() to set the gain.

Parameters
handlethe connected Atik device handle.
isPreviewwhether to set gain for preview mode or normal mode.
gainthe gain to set (scale of 1-24).
offsetthe offset to set.
See also
ARTEMISERROR, ArtemisCameraSpecificOptionSetData()
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisSetGpioDirection()

artfn int ArtemisSetGpioDirection ( ArtemisHandle  handle,
int  directionMask 
)
Parameters
handle
directionMask
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisSetGpioValues()

artfn int ArtemisSetGpioValues ( ArtemisHandle  handle,
int  lineValues 
)
Parameters
handlethe connected Atik device handle.
lineValues
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisSetLensAperture()

artfn int ArtemisSetLensAperture ( ArtemisHandle  handle,
int  aperture 
)

Sets the lens aperture.

Parameters
handlethe connected Atik device handle.
aperturethe aperture to set
See also
ARTEMISERROR, ArtemisGetLensLimits()
Returns
ARTEMIS_OK on success, ARTEMIS_INVALID_PARAMETER if value out of limits, ARTEMIS_NOT_INITIALIZED if lens not initialised, or ARTEMISERROR enumeration on failure

◆ ArtemisSetLensFocus()

artfn int ArtemisSetLensFocus ( ArtemisHandle  handle,
int  focus 
)

Sets the lens focus.

Parameters
handlethe connected Atik device handle.
focusthe focus value to set
See also
ARTEMISERROR, ArtemisGetLensLimits()
Returns
ARTEMIS_OK on success, ARTEMIS_INVALID_PARAMETER if value out of limits, ARTEMIS_NOT_INITIALIZED if lens not initialised, or ARTEMISERROR enumeration on failure

◆ ArtemisSetOverlappedExposureTime()

artfn int ArtemisSetOverlappedExposureTime ( ArtemisHandle  handle,
float  fSeconds 
)

Set the overlapped exposure time.

Parameters
handlethe connected Atik device handle.
fSecondsthe time as a floating point number of seconds.
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisSetPreview()

artfn int ArtemisSetPreview ( ArtemisHandle  handle,
bool  bPrev 
)

Sets whether preview mode is enabled for the device. If preview mode is enabled, the sensor is not cleared between exposures. Using preview mode, there might be more noise/glow in the resulting image.

Parameters
handlethe connected Atik device handle.
bPrevwhether to enable or disable preview mode.
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisSetProcessing()

artfn int ArtemisSetProcessing ( ArtemisHandle  handle,
int  options 
)

Sets which post processing effects are enabled for the device.

Parameters
handlethe connected Atik device handle.
optionsARTEMISPROCESSING enumeration of post processing flags to enable for the device.
See also
ARTEMISERROR, ARTEMISPROCESSING
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisSetShutterSpeed()

artfn int ArtemisSetShutterSpeed ( ArtemisHandle  handle,
int  speed 
)

Sets the shutter speed.

Parameters
handlethe connected Atik device handle.
speedthe speed to set, between 1 and 200.
See also
ARTEMISERROR, ArtemisCanSetShutterSpeed(), ArtemisGetShutterSpeed()
Returns
ARTEMIS_OK on success, ARTEMIS_INVALID_FUNCTION if the shutter speed is not supported for the device, or ARTEMISERROR enumeration on failure

◆ ArtemisSetSubSample()

artfn int ArtemisSetSubSample ( ArtemisHandle  handle,
bool  bSub 
)

Set whether subsampling mode is enabled on the device.

Parameters
handlethe connected Atik device handle.
bSub
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisSetWindowHeaterPower()

artfn int ArtemisSetWindowHeaterPower ( ArtemisHandle  handle,
int  windowHeaterPower 
)

Sets the window heater power.

Parameters
handlethe connected Atik device handle
windowHeaterPowerA value between 0 and 255 specifying the power to the window heater.
See also
ARTEMISERROR, ArtemisGetWindowHeaterPower()
Returns
ARTEMIS_OK on success, ARTEMARTEMIS_INVALID_PARAMETER if the device does not have a window heater, or ARTEMISERROR enumeration on failure

◆ ArtemisStartExposure()

artfn int ArtemisStartExposure ( ArtemisHandle  handle,
float  seconds 
)

Begin an exposure for the device, specifying a duration as floating point seconds.

Parameters
handlethe connected Atik device handle.
secondsthe seconds to perform the exposure for, as a floating point number.
See also
ARTEMISERROR, ArtemisStartExposureMS(), ArtemisAbortExposure()
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisStartExposureMS()

artfn int ArtemisStartExposureMS ( ArtemisHandle  handle,
int  ms 
)

Begin an exposure for the device, specifying a duration as milliseconds.

Parameters
handlethe connected Atik device handle.
msthe exposure duration in milliseconds.
See also
ARTEMISERROR, ArtemisStartExposure(), ArtemisAbortExposure()
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisStartFastExposure()

artfn BOOL ArtemisStartFastExposure ( ArtemisHandle  handle,
int  ms 
)

Begins a fast mode exposure.

Parameters
handlethe connected Atik device handle.
msthe exposure duration in milliseconds.
Returns
TRUE if started successfully, FALSE if not.

◆ ArtemisStartOverlappedExposure()

artfn int ArtemisStartOverlappedExposure ( ArtemisHandle  handle)

Begin an overlapped exposure.

Parameters
handlethe connected Atik device handle.
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisStopExposure()

artfn int ArtemisStopExposure ( ArtemisHandle  handle)

Stop the current exposure for the device. This is analogous to ArtemisAbortExposure().

Parameters
handlethe connected Atik device handle.
See also
ARTEMISERROR, ArtemisStartExposure(), ArtemisStartExposureMS(), ArtemisAbortExposure()
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisStopGuiding()

artfn int ArtemisStopGuiding ( ArtemisHandle  handle)
Parameters
handlethe connected Atik device handle.
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisStopGuidingBeforeDownload()

artfn int ArtemisStopGuidingBeforeDownload ( ArtemisHandle  handle,
bool  bEnable 
)
Parameters
handlethe connected Atik device handle.
bEnable
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisSubframe()

artfn int ArtemisSubframe ( ArtemisHandle  handle,
int  x,
int  y,
int  w,
int  h 
)

Set the device's subframe position and size. This is equivalent to calling ArtemisSubframePos() followed by ArtemisSubframeSize().

Parameters
handlethe connected camera's handle
xthe X offset of the subframe region.
ythe Y offset of the subframe region.
wthe width of the subframe region.
hthe height of the subframe region.
See also
ARTEMISERROR, ArtemisSubframePos(), ArtemisSubframeSize()
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisSubframePos()

artfn int ArtemisSubframePos ( ArtemisHandle  handle,
int  x,
int  y 
)

Sets the device's subframe position.

Parameters
handlethe connected Atik device handle.
xthe X offset of the subframe region.
ythe Y offset of the subframe region.
See also
ARTEMISERROR, ArtemisSubframe()
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisSubframeSize()

artfn int ArtemisSubframeSize ( ArtemisHandle  handle,
int  w,
int  h 
)

Sets the device's subframe width and height.

Parameters
handlethe connected Atik device handle.
wthe width of the subframe region.
hthe height of the subframe region.
See also
ARTEMISERROR, ArtemisSubframe()
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisTemperatureSensorInfo()

artfn int ArtemisTemperatureSensorInfo ( ArtemisHandle  handle,
int  sensor,
int *  temperature 
)

Gets temperature of the device for the specific sensor index, in hundreds of degrees centigrade. If "sensor" is set to 0, this will be set to the number of temperature sensors on the device.

Parameters
handlethe connected Atik device handle.
sensorthe index of the sensor to obtain information from.
temperaturea pointer to an integer which will be set to the temperature in tenths of degrees celsius, or the number of temperature sensors on the device.
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisTriggeredExposure()

artfn int ArtemisTriggeredExposure ( ArtemisHandle  handle,
bool  bAwaitTrigger 
)

Sets whether the device will await a triggered exposure.

Parameters
handlethe connected Atik device handle.
bAwaitTriggerwhether to await a triggered exposure
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisUnLoadDLL()

artfn void ArtemisUnLoadDLL ( )

Unloads the Atik DLL and frees the internal DLL handle. This method is only needed if the DLL is linked dynamically. This method is part of the DLL example code.

See also
ArtemisLoadDLL()

◆ ArtemisUploadFirmware()

artfn int ArtemisUploadFirmware ( ArtemisHandle  handle,
char *  fileName,
char *  password 
)

Upload a new firmware on the device. This API is for internal use.

Parameters
handlethe connected Atik device handle.
fileNamethe firmware file's full path.
passwordthe password needed to enable upload.
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure

◆ ArtemisWriteToEEPROM()

artfn int ArtemisWriteToEEPROM ( ArtemisHandle  handle,
char *  password,
int  address,
int  length,
const unsigned char *  data 
)

Writes a value to the EEPROM. This API is for internal use.

Parameters
handlethe connected Atik device handle.
passwordpassword required to interact with the device.
addressaddress of EEPROM
lengthlength of the data
datapointer to the buffer containing the data
See also
ARTEMISERROR
Returns
ARTEMIS_OK on success, or ARTEMISERROR enumeration on failure