Mercurial > hg > orthanc-stone
annotate OrthancStone/Sources/Volumes/IVolumeSlicer.h @ 1870:3889ae96d2e9
added copyright UCLouvain
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Tue, 11 Jan 2022 11:04:09 +0100 |
| parents | 9ac2a65d4172 |
| children | 7053b8a0aaec |
| rev | line source |
|---|---|
| 814 | 1 /** |
| 2 * Stone of Orthanc | |
| 3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics | |
| 4 * Department, University Hospital of Liege, Belgium | |
|
1739
9ac2a65d4172
upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1598
diff
changeset
|
5 * Copyright (C) 2017-2021 Osimis S.A., Belgium |
|
1870
3889ae96d2e9
added copyright UCLouvain
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1739
diff
changeset
|
6 * Copyright (C) 2021-2021 Sebastien Jodogne, ICTEAM UCLouvain, Belgium |
| 814 | 7 * |
| 8 * This program is free software: you can redistribute it and/or | |
|
1598
8563ea5d8ae4
relicensing some files, cf. osimis bm26 and chu agreement on 2020-05-20
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
9 * modify it under the terms of the GNU Lesser General Public License |
| 814 | 10 * as published by the Free Software Foundation, either version 3 of |
| 11 * the License, or (at your option) any later version. | |
| 12 * | |
| 13 * This program is distributed in the hope that it will be useful, but | |
| 14 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
|
1598
8563ea5d8ae4
relicensing some files, cf. osimis bm26 and chu agreement on 2020-05-20
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|
8563ea5d8ae4
relicensing some files, cf. osimis bm26 and chu agreement on 2020-05-20
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
16 * Lesser General Public License for more details. |
|
1596
4fb8fdf03314
removed annoying whitespace
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1571
diff
changeset
|
17 * |
|
1598
8563ea5d8ae4
relicensing some files, cf. osimis bm26 and chu agreement on 2020-05-20
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
18 * You should have received a copy of the GNU Lesser General Public |
|
8563ea5d8ae4
relicensing some files, cf. osimis bm26 and chu agreement on 2020-05-20
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
19 * License along with this program. If not, see |
|
8563ea5d8ae4
relicensing some files, cf. osimis bm26 and chu agreement on 2020-05-20
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
20 * <http://www.gnu.org/licenses/>. |
| 814 | 21 **/ |
| 22 | |
| 23 | |
| 24 #pragma once | |
| 25 | |
| 26 #include "../Scene2D/ILayerStyleConfigurator.h" | |
| 27 #include "../Toolbox/CoordinateSystem3D.h" | |
| 28 | |
| 29 namespace OrthancStone | |
| 30 { | |
| 31 /** | |
| 32 This interface is implemented by objects representing 3D volume data and | |
| 33 that are able to return an object that: | |
| 34 - represent a slice of their data | |
| 35 - are able to create the corresponding slice visual representation. | |
| 36 */ | |
| 37 class IVolumeSlicer : public boost::noncopyable | |
| 38 { | |
| 39 public: | |
| 40 /** | |
| 41 This interface is implemented by objects representing a slice of | |
| 42 volume data and that are able to create a 2D layer to display a this | |
| 43 slice. | |
| 44 | |
| 45 The CreateSceneLayer factory method is called with an optional | |
| 46 configurator that possibly impacts the ISceneLayer subclass that is | |
| 47 created (for instance, if a LUT must be applied on the texture when | |
| 48 displaying it) | |
| 49 */ | |
| 50 class IExtractedSlice : public boost::noncopyable | |
| 51 { | |
| 52 public: | |
| 53 virtual ~IExtractedSlice() | |
| 54 { | |
| 55 } | |
| 56 | |
| 57 /** | |
| 58 Invalid slices are created when the data is not ready yet or if the | |
| 59 cut is outside of the available geometry. | |
| 60 */ | |
| 61 virtual bool IsValid() = 0; | |
| 62 | |
| 63 /** | |
| 64 This retrieves the *revision* that gets incremented every time the | |
| 65 underlying object undergoes a mutable operation (that it, changes its | |
| 66 state). | |
| 67 This **must** be a cheap call. | |
| 68 */ | |
| 69 virtual uint64_t GetRevision() = 0; | |
| 70 | |
| 71 /** Creates the slice visual representation */ | |
| 72 virtual ISceneLayer* CreateSceneLayer( | |
| 73 const ILayerStyleConfigurator* configurator, // possibly absent | |
| 74 const CoordinateSystem3D& cuttingPlane) = 0; | |
| 75 }; | |
| 76 | |
| 77 /** | |
| 78 See IExtractedSlice.IsValid() | |
| 79 */ | |
| 80 class InvalidSlice : public IExtractedSlice | |
| 81 { | |
| 82 public: | |
| 1571 | 83 virtual bool IsValid() ORTHANC_OVERRIDE |
| 814 | 84 { |
| 85 return false; | |
| 86 } | |
| 87 | |
| 1571 | 88 virtual uint64_t GetRevision() ORTHANC_OVERRIDE; |
| 814 | 89 |
| 90 virtual ISceneLayer* CreateSceneLayer(const ILayerStyleConfigurator* configurator, | |
| 1571 | 91 const CoordinateSystem3D& cuttingPlane) ORTHANC_OVERRIDE; |
| 814 | 92 }; |
| 93 | |
| 94 | |
| 95 virtual ~IVolumeSlicer() | |
| 96 { | |
| 97 } | |
| 98 | |
| 99 /** | |
| 100 This method is implemented by the objects representing volumetric data | |
| 101 and must returns an IExtractedSlice subclass that contains all the data | |
| 102 needed to, later on, create its visual representation through | |
| 103 CreateSceneLayer. | |
| 104 Subclasses a.o.: | |
| 105 - InvalidSlice, | |
| 106 - DicomVolumeImageMPRSlicer::Slice, | |
| 107 - DicomVolumeImageReslicer::Slice | |
| 108 - DicomStructureSetLoader::Slice | |
| 109 */ | |
| 110 virtual IExtractedSlice* ExtractSlice(const CoordinateSystem3D& cuttingPlane) = 0; | |
| 111 }; | |
| 112 } |