diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000000000000000000000000000000000000..ca97d763baca0de263df8f331938a57065ea95f1 --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,64 @@ +variables: + GIT_SUBMODULE_STRATEGY: recursive + +stages: + - build + - deploy + +.build-conda: &build-conda + stage: build + artifacts: + paths: + - dist/ + tags: + - conda + +build-linux: + <<: *build-conda + script: + - conda build ./conda/camera --prefix-length=80 --output-folder=dist/ --channel=http://bcu-ci.esrf.fr/stable + tags: + - linux + +build-noarch: + <<: *build-conda + script: + - conda build ./conda/tango --prefix-length=80 --output-folder=dist/ --channel=http://bcu-ci.esrf.fr/stable + +deploy-devel: + stage: deploy + environment: + name: devel/$CI_COMMIT_REF_NAME + url: http://bcu-ci.esrf.fr/devel + dependencies: + - build-linux + - build-noarch + script: + - cp -Rf dist/* /conda-devel/ + - conda index /conda-devel/ + tags: + - conda + - linux + only: + - branches + except: + - stable + when: manual + +deploy-stable: + stage: deploy + environment: + name: production + url: http://bcu-ci.esrf.fr/stable + dependencies: + - build-linux + - build-noarch + script: + - cp -Rf dist/* /conda/ + - conda index /conda/ + tags: + - conda + - linux + only: + - tags + - stable diff --git a/CMakeLists.txt b/CMakeLists.txt index 7a724478ce9a3359bcb89e33a58a12f0d8a4cbad..825d36633091f15ae977e900ce76a3eaf567af7f 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -5,27 +5,95 @@ # European Synchrotron Radiation Facility # BP 220, Grenoble 38043 # FRANCE -# +# # Contact: lima@esrf.fr -# +# # This is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3 of the License, or # (at your option) any later version. -# +# # This software is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. -# +# # You should have received a copy of the GNU General Public License # along with this program; if not, see . ############################################################################ + +cmake_minimum_required(VERSION 3.1) + +project(slsdetector) + set(NAME slsdetector) +# Include additional modules that are used inconditionnaly +include(GNUInstallDirs) +include(GenerateExportHeader) + +# If conda build, always set lib dir to 'lib' +if($ENV{CONDA_BUILD}) + set(CMAKE_INSTALL_LIBDIR "lib") +endif() + +# Set lower / upper case project names +string(TOUPPER "${PROJECT_NAME}" PROJECT_NAME_UPPER) +string(TOLOWER "${PROJECT_NAME}" PROJECT_NAME_LOWER) + +# Set targets export name (used by lima and dependencies) +set(TARGETS_EXPORT_NAME "${PROJECT_NAME_LOWER}-targets") +#set(namespace "${PROJECT_NAME}::") + +# Check if project is being used directly or via add_subdirectory +set(CAMERA_MASTER_PROJECT OFF) +if (CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR) + set(CAMERA_MASTER_PROJECT ON) +endif() + +if (CAMERA_MASTER_PROJECT) + find_package(Lima REQUIRED) +endif() + +# CMake additional macros +set(CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake ${LIMA_CMAKE_INCLUDE_DIRS} ${CMAKE_MODULE_PATH}) + +# Set version +include(project_version) + +# Enable python binding code compilation using sip generator +option(CAMERA_ENABLE_PYTHON "compile python binding code?" LIMA_ENABLE_PYTHON) + +if (CAMERA_ENABLE_PYTHON) + # Find python interpreter and libs + find_package(PythonInterp) + find_package(PythonLibs) + if(${PYTHONINTERP_FOUND}) + # python site-packages folder + execute_process( + COMMAND ${PYTHON_EXECUTABLE} -c "from distutils.sysconfig import get_python_lib; print (get_python_lib())" + OUTPUT_VARIABLE _PYTHON_SITE_PACKAGES_DIR OUTPUT_STRIP_TRAILING_WHITESPACE) + endif() + + set(PYTHON_SITE_PACKAGES_DIR ${_PYTHON_SITE_PACKAGES_DIR} CACHE PATH "where should python modules be installed?") + + find_package(SIP REQUIRED) + include(SIPMacros) + if(WIN32) + set(SIP_TAGS WIN32_PLATFORM) + elseif(UNIX) + set(SIP_TAGS POSIX_PLATFORM) + endif(WIN32) + set(SIP_EXTRA_OPTIONS -e -g) + + find_package(NumPy REQUIRED) +endif() + +# Additional packages find_package(Numa REQUIRED) -set(SLS_DETECTOR_DIR slsDetectorPackage) +# slsDetectorPackage +set(SLS_DETECTOR_DIR ${CMAKE_CURRENT_SOURCE_DIR}/slsDetectorPackage) set(SLS_DETECTOR_SW ${SLS_DETECTOR_DIR}/slsDetectorSoftware) set(SLS_DETECTOR_RECV ${SLS_DETECTOR_DIR}/slsReceiverSoftware) @@ -35,47 +103,102 @@ option (USE_GUI "GUI" OFF) add_subdirectory(${SLS_DETECTOR_DIR}) -set(${NAME}_srcs src/SlsDetectorDefs.cpp - src/SlsDetectorArgs.cpp - src/SlsDetectorCPUAffinity.cpp - src/SlsDetectorModel.cpp - src/SlsDetectorReceiver.cpp - src/SlsDetectorCamera.cpp - src/SlsDetectorEiger.cpp - src/SlsDetectorInterface.cpp) - -add_library(lima${NAME} SHARED ${${NAME}_srcs}) - -target_include_directories(lima${NAME} PUBLIC - include - ${SLS_DETECTOR_SW}/include - ${SLS_DETECTOR_SW}/commonFiles - ${SLS_DETECTOR_SW}/slsDetector - ${SLS_DETECTOR_SW}/multiSlsDetector - ${SLS_DETECTOR_SW}/slsDetectorServer - ${SLS_DETECTOR_SW}/slsDetectorAnalysis - ${SLS_DETECTOR_SW}/slsReceiverInterface - ${SLS_DETECTOR_RECV}/include - ${NUMA_INCLUDE_DIR}) +file(GLOB_RECURSE SLSDETECTOR_INCS "${CMAKE_CURRENT_SOURCE_DIR}/include/*.h") + +add_library(slsdetector SHARED + src/SlsDetectorDefs.cpp + src/SlsDetectorArgs.cpp + src/SlsDetectorCPUAffinity.cpp + src/SlsDetectorModel.cpp + src/SlsDetectorReceiver.cpp + src/SlsDetectorCamera.cpp + src/SlsDetectorEiger.cpp + src/SlsDetectorInterface.cpp + ${SLSDETECTOR_INCS} +) + +# Generate export macros +generate_export_header(slsdetector) + +# Set version and output name +set_target_properties(slsdetector PROPERTIES + OUTPUT_NAME "lima${PROJECT_NAME_LOWER}" + VERSION "${PROJECT_VERSION}" + SOVERSION "${PACKAGE_VERSION_MAJOR}.${PACKAGE_VERSION_MINOR}") + +# Add dependencies +target_include_directories(slsdetector + PUBLIC "$" + PUBLIC "$" + PUBLIC "$" + PUBLIC "$" + PUBLIC "$" + PUBLIC "$" + PUBLIC "$" + PUBLIC "$" + PUBLIC "$" + PUBLIC "$" + PUBLIC "$" # For export header + PUBLIC "$" +) message("NUMA_LIBRARY=" ${NUMA_LIBRARY}) -target_link_libraries(lima${NAME} - limacore - slsDetectorShared slsReceiverShared zmq - ${NUMA_LIBRARY}) +target_link_libraries(slsdetector + PUBLIC limacore + PUBLIC slsDetectorShared slsReceiverShared zmq + PUBLIC ${NUMA_LIBRARY} +) -limatools_set_library_soversion(lima${NAME} VERSION) -install(TARGETS lima${NAME} LIBRARY DESTINATION lib) +# Binding code for python +if(CAMERA_ENABLE_PYTHON) + include(LimaTools) + limatools_run_sip_for_camera(slsdetector) +endif() -if(LIMA_ENABLE_PYTHON) - limatools_run_sip_for_camera(${NAME}) - install(FILES python/__init__.py DESTINATION - ${PYTHON_SITE_PACKAGES_DIR}/Lima/SlsDetector) +# Generate and install package config file and version +if(CAMERA_MASTER_PROJECT) + set (PROJECT_LIBRARIES slsdetector) + set(SIP_INSTALL_DIR ${CMAKE_INSTALL_DATADIR}/sip/lima) + set(CMAKE_INSTALL_DIR ${CMAKE_INSTALL_DATADIR}/cmake/lima) + include(package_config) endif() -set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake ${CMAKE_MODULE_PATH}) +## Installation + +install( + TARGETS slsdetector + EXPORT "${TARGETS_EXPORT_NAME}" + ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} # import library + LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} # .so files are libraries + RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR} # .dll files are binaries + INCLUDES DESTINATION ${CMAKE_INSTALL_INCLUDEDIR} # this does not actually install anything (but used by downstream projects) +) + +install( + DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/include/ + COMPONENT devel + DESTINATION ${CMAKE_INSTALL_INCLUDEDIR} + FILES_MATCHING PATTERN "*.h" +) + +install( + FILES + ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}/project_version.h + ${PROJECT_BINARY_DIR}/slsdetector_export.h + COMPONENT devel + DESTINATION ${CMAKE_INSTALL_INCLUDEDIR} +) + +if(CAMERA_ENABLE_PYTHON) + install( + DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/python/ + DESTINATION "${PYTHON_SITE_PACKAGES_DIR}/Lima/SlsDetector" + ) +endif() -if(LIMA_ENABLE_TESTS) - add_subdirectory(test/) +## Tests +if(CAMERA_ENABLE_TESTS) + enable_testing() + #add_subdirectory(test) endif() diff --git a/COPYING b/COPYING new file mode 100644 index 0000000000000000000000000000000000000000..94a9ed024d3859793618152ea559a168bbcbb5e2 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/VERSION b/VERSION deleted file mode 100644 index bd8bf882d06184bb54615a59477e3c5e35f522fc..0000000000000000000000000000000000000000 --- a/VERSION +++ /dev/null @@ -1 +0,0 @@ -1.7.0 diff --git a/cmake/project-config.cmake.in b/cmake/project-config.cmake.in new file mode 100644 index 0000000000000000000000000000000000000000..4bddb492bfdca53cf73cf688cb539d38ee19d46a --- /dev/null +++ b/cmake/project-config.cmake.in @@ -0,0 +1,18 @@ +# Config file for @PROJECT_NAME_LOWER@ +# +# It defines the following variables: +# +# @PROJECT_NAME_UPPER@_INCLUDE_DIRS - include directory +# @PROJECT_NAME_UPPER@_LIBRARIES - all dynamic libraries +# @PROJECT_NAME_UPPER@_STATIC_LIBRARIES - all static libraries + +@PACKAGE_INIT@ + +# Add dependencies here +include(CMakeFindDependencyMacro) +find_dependency(Lima) + +include("${CMAKE_CURRENT_LIST_DIR}/@TARGETS_EXPORT_NAME@.cmake") +check_required_components("@PROJECT_NAME@") + +check_required_components(@PROJECT_NAME_LOWER@) diff --git a/conda/camera/bld.bat b/conda/camera/bld.bat new file mode 100644 index 0000000000000000000000000000000000000000..5291c500465530b48b831cb0ce0fcfcb305f3497 --- /dev/null +++ b/conda/camera/bld.bat @@ -0,0 +1,5 @@ +cmake -Bbuild -H. -G "%CMAKE_GENERATOR%" -DCAMERA_ENABLE_PYTHON=1 -DCAMERA_ENABLE_TESTS=1 -DCMAKE_INSTALL_PREFIX=%LIBRARY_PREFIX% -DPYTHON_SITE_PACKAGES_DIR=%SP_DIR% -DCMAKE_FIND_ROOT_PATH=%LIBRARY_PREFIX% +IF %ERRORLEVEL% NEQ 0 exit /b %ERRORLEVEL% + +cmake --build build --config Release --target install +IF %ERRORLEVEL% NEQ 0 exit /b %ERRORLEVEL% diff --git a/conda/camera/build.sh b/conda/camera/build.sh new file mode 100644 index 0000000000000000000000000000000000000000..36840c4b8bcd420fda0fdf1009942797b225b8f7 --- /dev/null +++ b/conda/camera/build.sh @@ -0,0 +1,3 @@ +#!/bin/bash +cmake -Bbuild -H. -DCAMERA_ENABLE_PYTHON=1 -DCAMERA_ENABLE_TESTS=1 -DCMAKE_INSTALL_PREFIX=$PREFIX -DPYTHON_SITE_PACKAGES_DIR=$SP_DIR -DCMAKE_FIND_ROOT_PATH=$PREFIX +cmake --build build --target install diff --git a/conda/camera/conda_build_config.yaml b/conda/camera/conda_build_config.yaml new file mode 100644 index 0000000000000000000000000000000000000000..37b36eb27bc12c790939c6299a9edb18b1ccd94e --- /dev/null +++ b/conda/camera/conda_build_config.yaml @@ -0,0 +1,25 @@ +blas_impl: + - mkl # [x86_64] +c_compiler: + - vs2017 # [win] +cxx_compiler: + - vs2017 # [win] +python: + - 2.7 # [linux] + - 3.6 + - 3.7 +# This differs from target_platform in that it determines what subdir the compiler +# will target, not what subdir the compiler package will be itself. +# For example, we need a win-64 vs2008_win-32 package, so that we compile win-32 +# code on win-64 miniconda. +cross_compiler_target_platform: + - win-64 # [win] +target_platform: + - win-64 # [win] +vc: + - 14 +zip_keys: + - # [win] + - vc # [win] + - c_compiler # [win] + - cxx_compiler # [win] diff --git a/conda/camera/meta.yaml b/conda/camera/meta.yaml new file mode 100644 index 0000000000000000000000000000000000000000..c9fde80cfbe3653ada9af435ff6e5ecf12f65cf6 --- /dev/null +++ b/conda/camera/meta.yaml @@ -0,0 +1,46 @@ +{% set version = GIT_DESCRIBE_TAG[1:] %} + +package: + name: lima-camera-slsdetector + version: {{ version }} + +source: + path: ../.. + +build: + number: {{ environ.get('GIT_DESCRIBE_NUMBER', 0) }} + +requirements: + host: + - python {{ python }} + - numpy + - sip 4.19.8 # For compatibility with pyqt 5.9.2 + - lima-core + - libnuma + - libpng + build: + - git + - cmake + - {{ compiler('cxx') }} + run: + - python {{ python }} + - sip >=4.19.4, <=4.19.8 # For compatibility with pyqt 5.9.2 + - libpng + - libnuma + - lima-core + +test: + requires: + - cmake + imports: + - Lima.SlsDetector + commands: + - cmake --version + - ctest --version + - cpack --version + +about: + home: https://github.com/esrf-bliss/Lima + license: GPL + license_file: COPYING + summary: a library for the unified control of 2D detectors diff --git a/conda/tango/bld.bat b/conda/tango/bld.bat new file mode 100644 index 0000000000000000000000000000000000000000..adc93a7a7c10ad40130d0d516933da15fda5ade2 --- /dev/null +++ b/conda/tango/bld.bat @@ -0,0 +1 @@ +xcopy tango\*.* %SP_DIR%\Lima\Server\camera\ diff --git a/conda/tango/build.sh b/conda/tango/build.sh new file mode 100644 index 0000000000000000000000000000000000000000..662827a38e4bf57224725ac2c0d0fadbd6f071df --- /dev/null +++ b/conda/tango/build.sh @@ -0,0 +1 @@ +mkdir -p $SP_DIR/Lima/Server/camera && cp tango/*.* $SP_DIR/Lima/Server/camera diff --git a/conda/tango/meta.yaml b/conda/tango/meta.yaml new file mode 100644 index 0000000000000000000000000000000000000000..2d08d26053bf865113af1fc753f39c0ad325ed25 --- /dev/null +++ b/conda/tango/meta.yaml @@ -0,0 +1,23 @@ +{% set version = GIT_DESCRIBE_TAG[1:] %} + +package: + name: lima-camera-slsdetector-tango + version: {{ version }} + +source: + path: ../.. + +build: + number: {{ environ.get('GIT_DESCRIBE_NUMBER', 0) }} + noarch: python + +requirements: + run: + - lima-tango-server + - lima-camera-slsdetector + +about: + home: https://github.com/esrf-bliss/Lima + license: GPL + license_file: COPYING + summary: a library for the unified control of 2D detectors diff --git a/slsDetectorPackage b/slsDetectorPackage index 66d5db3476ecca170e0cddee1503b8d515af607f..479dae8e6b1569c050b1670757f0be84e0c79baa 160000 --- a/slsDetectorPackage +++ b/slsDetectorPackage @@ -1 +1 @@ -Subproject commit 66d5db3476ecca170e0cddee1503b8d515af607f +Subproject commit 479dae8e6b1569c050b1670757f0be84e0c79baa diff --git a/tango/SlsDetector.py b/tango/SlsDetector.py new file mode 100644 index 0000000000000000000000000000000000000000..5009bf6ac33c8ec007cdf8a9bee2315cfe2aeeb5 --- /dev/null +++ b/tango/SlsDetector.py @@ -0,0 +1,546 @@ +############################################################################ +# This file is part of LImA, a Library for Image Acquisition +# +# Copyright (C) : 2009-2011 +# European Synchrotron Radiation Facility +# BP 220, Grenoble 38043 +# FRANCE +# +# This is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 3 of the License, or +# (at your option) any later version. +# +# This software is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, see . +############################################################################ +#============================================================================= +# +# file : SlsDetector.py +# +# description : Python source for the PSI/SlsDetector and its commands. +# The class is derived from Device. It represents the +# CORBA servant object which will be accessed from the +# network. All commands which can be executed on the +# SlsDetector are implemented in this file. +# +# project : TANGO Device Server +# +# copyleft : European Synchrotron Radiation Facility +# BP 220, Grenoble 38043 +# FRANCE +# +#============================================================================= +# (c) - Bliss - ESRF +#============================================================================= +# +import time, string +import numpy as np +import PyTango +from collections import OrderedDict +from functools import partial + +from Lima import Core +from Lima import SlsDetector as SlsDetectorHw +from Lima.Server.AttrHelper import get_attr_4u, get_attr_string_value_list + +def ConstListAttr(nl, vl=None, Defs=SlsDetectorHw.Defs): + def g(x): + n = '' + was_cap = True + for c in x: + cap = c.isupper() + sep = '_' if cap and not was_cap else '' + n += sep + c.upper() + was_cap = cap or not c.isalpha() + return n + + if vl is None: + vl = [getattr(Defs, n) for n in nl] + return OrderedDict([(g(n), v) for n, v in zip(nl, vl)]) + + +class SlsDetector(PyTango.Device_4Impl): + + Core.DEB_CLASS(Core.DebModApplication, 'LimaSlsDetector') + + +#------------------------------------------------------------------ +# Device constructor +#------------------------------------------------------------------ + + MilliVoltSuffix = '_mv' + + def __init__(self,*args) : + PyTango.Device_4Impl.__init__(self,*args) + self.init_device() + +#------------------------------------------------------------------ +# Device destructor +#------------------------------------------------------------------ + def delete_device(self): + pass + +#------------------------------------------------------------------ +# Device initialization +#------------------------------------------------------------------ + @Core.DEB_MEMBER_FUNCT + def init_device(self): + self.set_state(PyTango.DevState.ON) + self.get_device_properties(self.get_device_class()) + + self.cam = _SlsDetectorCam + self.model = self.cam.getModel() + + self.init_list_attr() + self.init_dac_adc_attr() + + self.proc_finished = self.cam.getProcessingFinishedEvent() + self.proc_finished.registerStatusCallback(_SlsDetectorControl) + + self.cam.setTolerateLostPackets(self.tolerate_lost_packets) + self.netdev_groups = [g.split(',') for g in self.netdev_groups] + aff_array = self.pixel_depth_cpu_affinity_map + if aff_array: + flat_array = ','.join(aff_array).split(',') + aff_array = np.array(map(partial(int, base=0), flat_array)) + aff_map = self.getPixelDepthCPUAffinityMapFromArray(aff_array) + self.cam.setPixelDepthCPUAffinityMap(aff_map) + + def init_list_attr(self): + nl = ['FullSpeed', 'HalfSpeed', 'QuarterSpeed', 'SuperSlowSpeed'] + self.__ClockDiv = ConstListAttr(nl) + + vl, nl = self.cam.getValidReadoutFlags() + self.__ReadoutFlags = ConstListAttr(nl, vl) + + nl = ['PixelDepth4', 'PixelDepth8', 'PixelDepth16', 'PixelDepth32'] + bdl = map(lambda x: getattr(SlsDetectorHw, x), nl) + self.__PixelDepth = OrderedDict([(str(bd), int(bd)) for bd in bdl]) + + @Core.DEB_MEMBER_FUNCT + def init_dac_adc_attr(self): + nb_modules = self.cam.getNbDetSubModules() + name_list, idx_list, milli_volt_list = self.model.getDACInfo() + attr_name_list = map(lambda n: 'dac_' + n, name_list) + data_list = zip(idx_list, milli_volt_list) + self.dac_attr_idx_list = zip(attr_name_list, data_list) + for name, data in self.dac_attr_idx_list: + attr_data_dict = { + 'name': name, + 'dtype': PyTango.DevLong, + 'dformat': PyTango.SPECTRUM, + 'max_dim_x': nb_modules, + 'fget': self.read_dac, + 'fset': self.write_dac, + } + attr_data = PyTango.AttrData.from_dict(attr_data_dict) + self.add_attribute(attr_data) + + idx, has_mv = data + if has_mv: + attr_data_dict['name'] = name + self.MilliVoltSuffix + attr_data = PyTango.AttrData.from_dict(attr_data_dict) + self.add_attribute(attr_data) + + name_list, idx_list, factor_list, min_val_list = self.model.getADCInfo() + attr_name_list = map(lambda n: 'adc_' + n, name_list) + data_list = zip(idx_list, factor_list, min_val_list) + self.adc_attr_idx_list = zip(attr_name_list, data_list) + for name, data in self.adc_attr_idx_list: + attr_data_dict = { + 'name': name, + 'dtype': PyTango.DevDouble, + 'dformat': PyTango.SPECTRUM, + 'max_dim_x': nb_modules, + 'fget': self.read_adc, + } + attr_data = PyTango.AttrData.from_dict(attr_data_dict) + self.add_attribute(attr_data) + + @Core.DEB_MEMBER_FUNCT + def getAttrStringValueList(self, attr_name): + return get_attr_string_value_list(self, attr_name) + + def __getattr__(self, name): + if '_stats_' in name: + stats_tok = name.split('_stats_') + if stats_tok[1] in ['do_hist']: + stats_name = '_'.join(stats_tok) + return get_attr_4u(self, stats_name, SlsDetectorHw.SimpleStat) + return get_attr_4u(self, name, self.cam) + + @Core.DEB_MEMBER_FUNCT + def read_config_fname(self, attr): + deb.Return("config_fname=%s" % self.config_fname) + attr.set_value(self.config_fname) + + @Core.DEB_MEMBER_FUNCT + def putCmd(self, cmd): + deb.Param("cmd=%s" % cmd) + self.cam.putCmd(cmd); + + @Core.DEB_MEMBER_FUNCT + def getCmd(self, cmd): + deb.Param("cmd=%s" % cmd) + resp = self.cam.getCmd(cmd); + deb.Return("resp=%s" % resp) + return resp + + @Core.DEB_MEMBER_FUNCT + def read_dac_name_list(self, attr): + dac_name_list = [n for n, (i, m) in self.dac_attr_idx_list] + deb.Return("dac_name_list=%s" % (dac_name_list,)) + attr.set_value(dac_name_list) + + @Core.DEB_MEMBER_FUNCT + def read_dac_name_list_mv(self, attr): + mv = self.MilliVoltSuffix + dac_name_list = [n + mv for n, (i, m) in self.dac_attr_idx_list if m] + deb.Return("dac_name_list=%s" % (dac_name_list,)) + attr.set_value(dac_name_list) + + @Core.DEB_MEMBER_FUNCT + def get_dac_name_mv(self, dac_name): + mv = self.MilliVoltSuffix + is_mv = dac_name.endswith(mv) + if is_mv: + dac_name = dac_name[:-len(mv)] + return dac_name, is_mv + + @Core.DEB_MEMBER_FUNCT + def read_dac(self, attr): + dac_name, milli_volt = self.get_dac_name_mv(attr.get_name()) + deb.Param("dac_name=%s, milli_volt=%s" % (dac_name, milli_volt)) + idx, has_mv = dict(self.dac_attr_idx_list)[dac_name] + val_list = self.cam.getDACList(idx, milli_volt) + deb.Return("val_list=%s" % val_list) + attr.set_value(val_list) + + @Core.DEB_MEMBER_FUNCT + def write_dac(self, attr): + dac_name, milli_volt = self.get_dac_name_mv(attr.get_name()) + idx, has_mv = dict(self.dac_attr_idx_list)[dac_name] + deb.Param("dac_name=%s, milli_volt=%s" % (dac_name, milli_volt)) + for i, val in self.get_write_mod_idx_val_list(attr): + self.cam.setDAC(i, idx, val, milli_volt) + + @Core.DEB_MEMBER_FUNCT + def read_all_trim_bits(self, attr): + val_list = self.cam.getAllTrimBitsList() + deb.Return("val_list=%s" % val_list) + attr.set_value(val_list) + + @Core.DEB_MEMBER_FUNCT + def write_all_trim_bits(self, attr): + for i, val in self.get_write_mod_idx_val_list(attr): + self.cam.setAllTrimBits(i, val) + + @Core.DEB_MEMBER_FUNCT + def get_write_mod_idx_val_list(self, attr): + attr_name = attr.get_name() + val_list = attr.get_write_value() + deb.Param("attr_name=%s, val_list=%s" % (attr_name, val_list)) + msg = None + nb_val = len(val_list) + if (val_list < 0).sum() == nb_val: + msg = 'Invalid %s: %s' % (attr_name, val_list) + elif nb_val == 1: + mod_idx_list = [-1] + elif nb_val == self.cam.getNbDetSubModules(): + mod_idx_list = range(nb_val) + else: + msg = 'Invalid %s length: %s' % (att_name, val_list) + if msg: + deb.Error(msg) + raise ValueError(msg) + return [(i, val) for i, val in zip(mod_idx_list, val_list) if val >= 0] + + @Core.DEB_MEMBER_FUNCT + def read_adc_name_list(self, attr): + adc_name_list = zip(*self.adc_attr_idx_list)[0] + deb.Return("adc_name_list=%s" % (adc_name_list,)) + attr.set_value(adc_name_list) + + @Core.DEB_MEMBER_FUNCT + def read_adc(self, attr): + idx, factor, min_val = dict(self.adc_attr_idx_list)[attr.get_name()] + val_list = self.cam.getADCList(idx) + out_arr = np.array(val_list, 'float64') * factor + min_val + deb.Return("out_arr=%s" % out_arr) + attr.set_value(out_arr) + + @Core.DEB_MEMBER_FUNCT + def read_max_frame_rate(self, attr): + time_ranges = self.model.getTimeRanges() + max_frame_rate = 1 / time_ranges.min_frame_period / 1e3; + deb.Return("max_frame_rate=%s" % max_frame_rate) + attr.set_value(max_frame_rate) + + @Core.DEB_MEMBER_FUNCT + def getNbBadFrames(self, port_idx): + nb_bad_frames = self.cam.getNbBadFrames(port_idx); + deb.Return("nb_bad_frames=%s" % nb_bad_frames) + return nb_bad_frames + + @Core.DEB_MEMBER_FUNCT + def getBadFrameList(self, port_idx): + bad_frame_list = self.cam.getBadFrameList(port_idx); + deb.Return("bad_frame_list=%s" % bad_frame_list) + return bad_frame_list + + @Core.DEB_MEMBER_FUNCT + def getStats(self, port_idx_stats_name): + port_idx_str, stats_name = port_idx_stats_name.split(':') + port_idx = int(port_idx_str) + deb.Param("port_idx=%s, stats_name=%s"); + stats = self.cam.getStats(port_idx) + stat = getattr(stats, stats_name) + stat_data = [stat.min(), stat.max(), stat.ave(), stat.std(), stat.n()] + deb.Return("stat_data=%s" % stat_data) + return stat_data + + @Core.DEB_MEMBER_FUNCT + def getStatsHistogram(self, port_idx_stats_name): + port_idx_str, stats_name = port_idx_stats_name.split(':') + port_idx = int(port_idx_str) + deb.Param("port_idx=%s, stats_name=%s"); + stats = self.cam.getStats(port_idx) + stat = getattr(stats, stats_name) + stat_data = np.array(stat.hist).flatten() + deb.Return("stat_data=%s" % stat_data) + return stat_data + + def getCPUAffinityLen(self): + return 5 + len(self.netdev_groups); + + @Core.DEB_MEMBER_FUNCT + def getArrayFromPixelDepthCPUAffinityMap(self, aff_map): + nb_pixel_depth = len(aff_map) + aff_len = self.getCPUAffinityLen() + aff_array = np.zeros((nb_pixel_depth, aff_len), 'int') + for i, (pixel_depth, global_affinity) in enumerate(aff_map.items()): + aff_array[i][:5] = (pixel_depth, + global_affinity.recv.listeners, + global_affinity.recv.writers, + global_affinity.lima, + global_affinity.other) + for ng_aff in global_affinity.netdev: + j = self.netdev_groups.index(ng_aff.name_list) + aff_array[i][5 + j] = ng_aff.processing + return aff_array + + @Core.DEB_MEMBER_FUNCT + def getPixelDepthCPUAffinityMapFromArray(self, aff_array): + aff_len = self.getCPUAffinityLen() + err = ValueError("Invalid pixel_depth_cpu_affinity_map: " + "must be a list of %d-value tuples" % aff_len) + if len(aff_array.shape) == 1: + if len(aff_array) % aff_len != 0: + raise err + aff_array.resize((len(aff_array) / aff_len, aff_len)) + if aff_array.shape[1] != aff_len: + raise err + aff_map = {} + CPUAffinity = SlsDetectorHw.CPUAffinity + NetDevGroupCPUAffinity = SlsDetectorHw.NetDevGroupCPUAffinity + GlobalCPUAffinity = SlsDetectorHw.GlobalCPUAffinity + for aff_data in aff_array: + aff_data = map(int, aff_data) + pixel_depth, recv_l, recv_w, lima, other = aff_data[:5] + netdev_aff = aff_data[5:] + global_affinity = GlobalCPUAffinity() + global_affinity.recv.listeners = CPUAffinity(recv_l) + global_affinity.recv.writers = CPUAffinity(recv_w) + global_affinity.lima = CPUAffinity(lima) + global_affinity.other = CPUAffinity(other) + ng_aff_list = [] + for name_list, a in zip(self.netdev_groups, netdev_aff): + ng_aff = NetDevGroupCPUAffinity() + ng_aff.name_list = name_list + ng_aff.processing = CPUAffinity(a) + ng_aff_list.append(ng_aff) + global_affinity.netdev = ng_aff_list + aff_map[pixel_depth] = global_affinity + return aff_map + + @Core.DEB_MEMBER_FUNCT + def read_netdev_groups(self, attr): + netdev_groups = [','.join(g) for g in self.netdev_groups] + deb.Return("aff_array=%s" % netdev_groups) + attr.set_value(netdev_groups) + + @Core.DEB_MEMBER_FUNCT + def write_netdev_groups(self, attr): + netdev_groups = [g.split(',') for g in attr.get_write_value()] + deb.Param("aff_array=%s" % netdev_groups) + self.netdev_groups = netdev_groups + + @Core.DEB_MEMBER_FUNCT + def read_pixel_depth_cpu_affinity_map(self, attr): + aff_map = self.cam.getPixelDepthCPUAffinityMap() + aff_array = self.getArrayFromPixelDepthCPUAffinityMap(aff_map) + deb.Return("aff_array=%s" % aff_array) + attr.set_value(aff_array) + + @Core.DEB_MEMBER_FUNCT + def write_pixel_depth_cpu_affinity_map(self, attr): + aff_array = attr.get_write_value() + deb.Param("aff_array=%s" % aff_array) + aff_map = self.getPixelDepthCPUAffinityMapFromArray(aff_array) + self.cam.setPixelDepthCPUAffinityMap(aff_map) + + +class SlsDetectorClass(PyTango.DeviceClass): + + class_property_list = {} + + device_property_list = { + 'config_fname': + [PyTango.DevString, + "Path to the SlsDetector config file",[]], + 'tolerate_lost_packets': + [PyTango.DevBoolean, + "Initial tolerance to lost packets", True], + 'netdev_groups': + [PyTango.DevVarStringArray, + "List of network device groups, each group is a list of " + "comma-separated interface names: [\"ethX,ethY\", \"ethZ,...\"]", []], + 'pixel_depth_cpu_affinity_map': + [PyTango.DevVarStringArray, + "Default PixelDepthCPUAffinityMap as a list of 5+n-value tuple " + "strings (n is nb of netdev_groups): " + "[\",,,," + "[,,...]\", ...]", []], + } + + cmd_list = { + 'getAttrStringValueList': + [[PyTango.DevString, "Attribute name"], + [PyTango.DevVarStringArray, "Authorized String value list"]], + 'putCmd': + [[PyTango.DevString, "SlsDetector command"], + [PyTango.DevVoid, ""]], + 'getCmd': + [[PyTango.DevString, "SlsDetector command"], + [PyTango.DevString, "SlsDetector response"]], + 'getNbBadFrames': + [[PyTango.DevLong, "port_idx(-1=all)"], + [PyTango.DevLong, "Number of bad frames"]], + 'getBadFrameList': + [[PyTango.DevLong, "port_idx(-1=all)"], + [PyTango.DevVarLongArray, "Bad frame list"]], + 'getStats': + [[PyTango.DevString, "port_idx(-1=all):stats_name"], + [PyTango.DevVarDoubleArray, "Statistics: min, max, ave, std, n"]], + 'getStatsHistogram': + [[PyTango.DevString, "port_idx(-1=all):stats_name"], + [PyTango.DevVarDoubleArray, "[[bin, count], ...]"]], + } + + attr_list = { + 'config_fname': + [[PyTango.DevString, + PyTango.SCALAR, + PyTango.READ]], + 'hostname_list': + [[PyTango.DevString, + PyTango.SPECTRUM, + PyTango.READ, 64]], + 'dac_name_list': + [[PyTango.DevString, + PyTango.SPECTRUM, + PyTango.READ, 64]], + 'dac_name_list_mv': + [[PyTango.DevString, + PyTango.SPECTRUM, + PyTango.READ, 64]], + 'adc_name_list': + [[PyTango.DevString, + PyTango.SPECTRUM, + PyTango.READ, 64]], + 'pixel_depth': + [[PyTango.DevString, + PyTango.SCALAR, + PyTango.READ_WRITE]], + 'raw_mode': + [[PyTango.DevBoolean, + PyTango.SCALAR, + PyTango.READ_WRITE]], + 'threshold_energy': + [[PyTango.DevLong, + PyTango.SCALAR, + PyTango.READ_WRITE]], + 'all_trim_bits': + [[PyTango.DevLong, + PyTango.SPECTRUM, + PyTango.READ_WRITE, 64]], + 'clock_div': + [[PyTango.DevString, + PyTango.SCALAR, + PyTango.READ_WRITE]], + 'readout_flags': + [[PyTango.DevString, + PyTango.SCALAR, + PyTango.READ_WRITE]], + 'max_frame_rate': + [[PyTango.DevDouble, + PyTango.SCALAR, + PyTango.READ]], + 'tolerate_lost_packets': + [[PyTango.DevBoolean, + PyTango.SCALAR, + PyTango.READ_WRITE]], + 'netdev_groups': + [[PyTango.DevString, + PyTango.SPECTRUM, + PyTango.READ_WRITE, 64]], + 'pixel_depth_cpu_affinity_map': + [[PyTango.DevLong, + PyTango.IMAGE, + PyTango.READ_WRITE, 64, 5]], + 'stats_do_hist': + [[PyTango.DevBoolean, + PyTango.SCALAR, + PyTango.READ_WRITE]], + } + + def __init__(self,name) : + PyTango.DeviceClass.__init__(self,name) + self.set_type(name) + + +#---------------------------------------------------------------------------- +# Plugin +#---------------------------------------------------------------------------- +_SlsDetectorCam = None +_SlsDetectorHwInter = None +_SlsDetectorEiger = None +_SlsDetectorCorrection = None +_SlsDetectorControl = None + +def get_control(config_fname, **keys) : + global _SlsDetectorCam, _SlsDetectorHwInter, _SlsDetectorEiger + global _SlsDetectorCorrection, _SlsDetectorControl + if _SlsDetectorControl is None: + _SlsDetectorCam = SlsDetectorHw.Camera(config_fname) + _SlsDetectorHwInter = SlsDetectorHw.Interface(_SlsDetectorCam) + if _SlsDetectorCam.getType() == SlsDetectorHw.EigerDet: + _SlsDetectorEiger = SlsDetectorHw.Eiger(_SlsDetectorCam) + _SlsDetectorCorrection = _SlsDetectorEiger.createCorrectionTask() + else: + raise ValueError("Unknown detector type: %s" % + _SlsDetectorCam.getType()) + _SlsDetectorControl = Core.CtControl(_SlsDetectorHwInter) + if _SlsDetectorCorrection: + _SlsDetectorControl.setReconstructionTask(_SlsDetectorCorrection) + + return _SlsDetectorControl + +def get_tango_specific_class_n_device(): + return SlsDetectorClass, SlsDetector