PylonCameraOptions.h

Go to the documentation of this file.

/********************************************************************
**                Image Component Library (ICL)                    **
**                                                                 **
** Copyright (C) 2006-2013 CITEC, University of Bielefeld          **
**                         Neuroinformatics Group                  **
** Website: www.iclcv.org and                                      **
**          http://opensource.cit-ec.de/projects/icl               **
**                                                                 **
** File   : ICLIO/src/ICLIO/PylonCameraOptions.h                   **
** Module : ICLIO                                                  **
** Authors: Viktor Richter                                         **
**                                                                 **
**                                                                 **
** GNU LESSER GENERAL PUBLIC LICENSE                               **
** This file may be used under the terms of the GNU Lesser General **
** Public License version 3.0 as published by the                  **
**                                                                 **
** Free Software Foundation and appearing in the file LICENSE.LGPL **
** included in the packaging of this file.  Please review the      **
** following information to ensure the license requirements will   **
** be met: http://www.gnu.org/licenses/lgpl-3.0.txt                **
**                                                                 **
** The development of this software was supported by the           **
** Excellence Cluster EXC 277 Cognitive Interaction Technology.    **
** The Excellence Cluster EXC 277 is a grant of the Deutsche       **
** Forschungsgemeinschaft (DFG) in the context of the German       **
** Excellence Initiative.                                          **
**                                                                 **
********************************************************************/

#pragma once

#include <ICLIO/PylonIncludes.h>

#include <ICLUtils/Macros.h>
#include <ICLIO/PylonUtils.h>
#include <ICLUtils/Configurable.h>

namespace icl {
  namespace io{
    namespace pylon {

      class ICLIO_API PylonCameraOptions : public utils::Configurable{
        public:

          PylonCameraOptions(Pylon::IPylonDevice* camera, Interruptable* interu);

          ~PylonCameraOptions();

          Pylon::PixelType getCameraPixelType();
          int getCameraPixelSize();
          long getNeededBufferSize();
          void acquisitionStart();
          void acquisitionStop();
          int getHeight();
          int getWidth();
          std::string getFormatString();
          bool omitDoubleFrames();
          double getResultingFrameRateAbs();

        private:
          Interruptable* m_Interu;
          Pylon::IPylonDevice* m_Camera;
          bool m_OmitDoubleFrames;

          std::string getType(const std::string &name);
          std::string getInfo(const std::string &name);
          std::string getValue(const std::string &name);
          int isVolatile(const std::string &propertyName);
          void processPropertyChange(const utils::Configurable::Property &prop);
          void addToPropertyList(std::vector<std::string> &ps, const GenApi::CNodePtr& node);

          GenApi::INode *getNode(std::string name);
      };

    } // namespace pylon

    // here come some convenience functions for pylon namespace
    namespace pylon {

      template <typename NODE, typename RET>
      RET getNodeValue(NODE* node){
        return node -> GetValue();
      }

      template <typename NODE, typename RET>
      int64_t getNodeValue(GenApi::IEnumeration* node){
        return node -> GetIntValue();
      }

      template <typename NODE, typename VAL>
      void setNodeValue(NODE* node, VAL value){
        node -> SetValue(value, true);
        return;
      }

      template <typename NODE, typename VAL>
      void setNodeValue(GenApi::IEnumeration* node, std::string value){
        node -> FromString(value.c_str(), true);
        return;
      }

      template <typename NODE, typename VAL>
      void setNodeValue(GenApi::IEnumeration* node, int64_t value){
        node -> SetIntValue(value, true);
        return;
      }

      template <typename OBJ, typename NODE, typename VAL>
      bool setParameterValueOf(OBJ* object, std::string parameter, VAL value){
        GenApi::INode* node = object -> GetNodeMap() -> GetNode(parameter.c_str());
        if (!node) {
          DEBUG_LOG("There is no parameter called '" << parameter << "'")
              return false;
        }
        //dynamic cast to needed node-type
        NODE* node2;
        try{
          node2 = dynamic_cast<NODE*>(node);
        } catch (std::exception &e){
          DEBUG_LOG ("Could not cast node '"<< parameter << "' to desired type2")
              return false;
        }
        if(!GenApi::IsWritable(node2)){
          DEBUG_LOG("Parameter called '" << parameter << "' is not writable.")
              return false;
        }
        // now setting parameter
        try{
          setNodeValue<NODE, VAL>(node2, value);
          return true;
        }
        catch (GenICam::GenericException &e) {
          std::cerr << e.what() << std::endl;
          return false;
        }
      }

      template <typename SOURCE, typename NODE, typename RET>
      RET getParameterValueOf(SOURCE* source, std::string param){
        GenApi::INode* node = source -> GetNodeMap() -> GetNode(param.c_str());
        if(!node){
          throw utils::ICLException("parameter of this type not found");
        }
        //dynamic cast to needed node-type
        try{
          NODE* node2 = dynamic_cast<NODE*>(node);
          if(!node2){
            throw utils::ICLException("Could not cast " + param + " to desired type");
          }
          if(!GenApi::IsReadable(node2)){
            throw utils::ICLException("The node " + param + " is not Readable");
          }
          return getNodeValue<NODE, RET>(node2);
        } catch (std::exception &e){
          throw utils::ICLException(e.what());
        }
      }

      ICLIO_API std::string getParameterValueString(
          Pylon::IPylonDevice* device, std::string parameter);

    } //namespace pylon
  } // namespace io
} //namespace icl