include/Geant4/G4VCurvedTrajectoryFilter.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 // G4VCurvedTrajectoryFilter
0027 //
0028 // Class description:
0029 //
0030 // Decides which intermediate points on a curved trajectory merit
0031 // being stored. Defines the compromise between accuracy of
0032 // representation of the curved trajectory and memory use.
0033 //
0034 // Derived classes should implement the filtering algorithm in the
0035 // method TakeIntermediatePoint().
0036 //
0037 // IMPORTANT: This class heap allocates vectors of auxiliary points,
0038 // which it does not delete. The vectors must find their way to a
0039 // subclass of G4VTrajectoryPoint, which must take responsibility for
0040 // deleting them.
0041
0042 // Author: Jacek Generowicz (CERN), 30.10.2002
0043 // ------------------------------------------------------------------------
0044 #ifndef G4VCURVEDTRAJECTORYFILTER_HH
0045 #define G4VCURVEDTRAJECTORYFILTER_HH
0046
0047 #include "G4ThreeVector.hh"
0048 #include <vector>
0049
0050 /**
0051  * @brief G4VCurvedTrajectoryFilter defines a filter for deciding which
0052  * intermediate points on a curved trajectory merit being stored. It defines
0053  * the compromise between accuracy of representation of the curved trajectory
0054  * and memory use. Derived classes should implement the filtering algorithm.
0055  */
0056
0057 class G4VCurvedTrajectoryFilter
0058 {
0059   public:
0060
0061     /**
0062      * Default Constructor & Destructor.
0063      */
0064     G4VCurvedTrajectoryFilter() = default;
0065     virtual ~G4VCurvedTrajectoryFilter() = default;
0066
0067     // Probably do not want these objects to be copied,
0068     // so make the copy constructor deleted in derived classes.
0069
0070     /**
0071      * Each segment stores the auxiliary points of a single step.
0072      */
0073     void CreateNewTrajectorySegment();
0074
0075     /**
0076      * Submits intermediate points for the filter to consider keeping or
0077      * rejecting. Derived classes should implement the filtering algorithm
0078      * in this method.
0079      */
0080     virtual void TakeIntermediatePoint( G4ThreeVector newPoint ) = 0;
0081
0082     /**
0083      * Returns the vector of points, transferring the ownership.
0084      */
0085     std::vector<G4ThreeVector>* GimmeThePointsAndForgetThem();
0086
0087   protected:
0088
0089     std::vector<G4ThreeVector>* fpFilteredPoints = nullptr;
0090 };
0091
0092 #endif