Skip to content

Latest commit

 

History

History
97 lines (69 loc) · 5.51 KB

README.md

File metadata and controls

97 lines (69 loc) · 5.51 KB
Raw

DIPOL-UF (DIPOL-3)

DOI

dipol-uf-gui

This repository contains software needed for operation of high-precision three-color BVR polarimeter DIPol-UF. The libraries here are designed to handle low-level communication with Trinamic stepper motors, utilize ANDOR SDK capabilities to control three (but in principle, any numer of) ANDOR iXon Ultra 897 CCDs, acquire and serailzie obtained images in FITS format.

The current version does not support full range of features of an ANDOR-compatible camera. A subset of regimes needed for DIPol-UF is implemented and tested. The system is scalable in a sense that it supports RPC communication over the network. Each camera can be controlled by a separate Windows machine, and the number of such machines is limited by the network capabilities (DIPol-UF uses one primary cotntrol PC and two seondary PCs which provide RPC capabilities). Due to the nature of polarimetric observations, DIPol-UF does not requrie extremely precies triggering mechanisms (a typical exposure time is ~1-60 s with a 0.250 s overhead for discrete plate rotation after each exposure), so no support for external triggers is built in (yet).

The GUI is built using WPF. RPC is implemented using WCF. The project was initiated well before the release of a stable .NET Core (with at least WPF support), so core GUI and RPC features are .NET Frmework 4.8-only. Auxilary libraries target .NET Standard 2.0 and are fully cross-platform.

An effort is made to solve some of the problems present in code base and to migrate all of the libraries to .NET Standard 2.0/2.1 with executables targeting .NET 5+.

Project structure

  • ANDOR-CS is the high level wrapper around native ANDOR libs and provides tools to control local ANDOR cameras.

  • DIPOL-Remote provides (net.tcp) service and client allowing to remotely control camera connected to another computer.

  • DIPOL-UF is the GUI project oriented to end users.

  • FITS-CS provides IO support for FITS images (only one-image per file, no other extensions).

  • StepMotor provides tools for interaction with Step Motor - device responsible for phase plate rotation during polarimetric observations.

  • DipolImage contains Image class that handles all image transport in a project.

  • Host is a standalone application (.exe) that is launched on each of the secondary PC and allows over-the-network communication with the cameras.

Building and testing

The ANDOR-CS project depends on the ANDOR SDK, which is proprietary and is not distributed. When obtained, the SDK can be directly referenced in the *.csproj instead of a placeholder nuget package. The ANDOR SDK libraries are architecture sensitive (including the C# wrappers), so take this into account.

The subset of tests of auxilary functions is found in /tests/. The test solution can be executed as is using .NET 5+. By default, it targets .NET Framewrok 4.8, .NET 5 and $(DOTNET_EXTRA_TARGET) environemnt variable, which can be set to target to any other .NET version (e.g., .NET 6 preview). The tests are then executed as

dotnet test ./tests/Tests.sln -c Release -f <TESTED_FRAMEWOR>,

where <TESTED_FRAMEWORK> can be net4.8, net5.0, etc.

To build Host and DIPOL-UF, msbuild should be used. Providing the ANDOR dependencies are added, the GUI can be built as

msbuild ./src/DIPOL-UF/DIPOL-UF.csproj -p:Configuration=Relase -p:Platform=<PLATFORM>,

where <PLATFORM> is either x64 or x86 (for 32-bit).

Examples of build & test workflows can be found in the CI scripts

The /scripts folder contains automation scripts that can be used for testing and building executables.

Development environement configuration using choco

choco install visualstudio2019buildtools -y
choco install visualstudio2019-workload-manageddesktopbuildtools -y
choco install netfx-4.8-devpack dotnet-5.0-sdk -y
choco install git

Citations

Please use the following BibTex entry whenever you want to cite this project:

@ARTICLE{2021AJ....161...20P,
       author = {{Piirola}, Vilppu and {Kosenkov}, Ilia A. and {Berdyugin}, Andrei V. and {Berdyugina}, Svetlana V. and {Poutanen}, Juri},
        title = "{Double Image Polarimeter{\textemdash}Ultra Fast: Simultaneous Three-color (BV R) Polarimeter with Electron-multiplying Charge-coupled Devices}",
      journal = {\aj},
     keywords = {Observational astronomy, Polarimeters, Photometer, Polarimetry, High energy astrophysics, Black holes, Binary stars, 1145, 1277, 2030, 1278, 739, 162, 154},
         year = 2021,
        month = jan,
       volume = {161},
       number = {1},
          eid = {20},
        pages = {20},
          doi = {10.3847/1538-3881/abc74f},
       adsurl = {https://ui.adsabs.harvard.edu/abs/2021AJ....161...20P},
      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}