Name Date Size #Lines LOC

..21-Feb-2019-

include/pcl/H21-Feb-2019-

src/H21-Feb-2019-

CODING_STYLE.mdH A D21-Feb-201918.6 KiB643455

COPYING.mdH A D21-Feb-20192.2 KiB4231

LICENSE.txtH A D21-Feb-20192.3 KiB4433

README.mdH A D25-Feb-20199.6 KiB200128

README.md

1PCL - PixInsight Class Library
2------------------------------
3
4[PixInsight](https://pixinsight.com/) is an advanced image processing software platform designed specifically for astronomy and other technical imaging applications. PixInsight is a modular, open-architecture system where the entire processing and file handling capabilities are implemented as external installable modules.
5
6The PixInsight core application provides the infrastructure on top of which external modules can implement processes, image file formats, and their associated user interfaces. The [PixInsight Class Library](https://pixinsight.com/developer/pcl/) (PCL) is a C++ development framework to build PixInsight modules.
7
8PixInsight modules are special shared libraries (.so files on FreeBSD and Linux; .dylib under macOS; .dll files on Windows) that communicate with the PixInsight core application through a high-level API provided by PCL. Along with a core communication API, PCL includes a comprehensive set of image processing algorithms, ranging from geometrical transformations to multiscale analysis algorithms, most of them available as multithreaded parallel implementations. PCL provides also rigorous and efficient implementations of essential astronomical algorithms, including state-of-the-art solar system ephemerides, vector astrometry, and reduction of positions of solar system and stellar objects.
9
10PCL is highly portable code. As of writing this document, it is available on the same platforms supported by the PixInsight core application: 64-bit FreeBSD, Linux, macOS, and Windows. PixInsight modules written around PCL are directly portable to all supported platforms *without changing a single line of source code*. This is possible because PCL is a high-level framework. PCL isolates your module from platform-specific implementation details: all platform-dependent complexities are handled behind the scenes by the PixInsight core application and internal PCL routines.
11
12Starting from version 2.0, which was published in December of 2012, PCL is an open-source library released under the [PixInsight Class Library License](https://pixinsight.com/license/PCL_PJSR_1.0.html) (PCLL). In essence, PCLL is a liberal BSD-like license that allows you to develop open-source and closed-source, free and commercial PixInsight modules without restrictions. As long as you observe all PCLL terms, you can modify PCL and use your modified version with or without releasing your source code.
13
14A good starting point for developing PixInsight modules is the src/modules directory, where you'll find all open-source modules that form part of the official PixInsight distribution. You may also want to take a look at the PCL Reference Documentation mentioned below. PixInsight and PCL are supported by a vibrant community on [PixInsight Forum](https://pixinsight.com/forum/), which also contains a developers section. Join us there!
15
16## PCL Reference Documentation
17
18The official reference documentation for PCL has been generated automatically from PCL source code files with the [Doxygen](http://www.doxygen.nl/) documentation tool.
19
20[PCL Reference Documentation - HTML Format](https://pixinsight.com/developer/pcl/doc/html/index.html)
21
22Currently the PCL documentation is fairly complete, although there are still some classes and functions lacking detailed descriptions. If you find errors or inaccuracies in our documentation, we'd like to hear you to get them fixed. If you want to collaborate with us to enhance the existing PCL documentation, you are also welcome.
23
24
25## PCL Repository
26
27This PCL repository includes all standard PCL headers and source code, along with all third-party libraries required to build PCL on the user's machine. The repository also contains the complete source code of all standard PixInsight modules that have been released as open-source products, most of them under PCLL license.
28
29Here is a list of subdirectories, along with descriptions of the files therein. We assume that the PCL distribution has been installed on a <PCL> directory on your local filesystem; for example:
30
31<dl><dd>
32   UNIX and Linux : [PCL] = $HOME/PCL<br/>
33   Windows        : [PCL] = C:\PCL
34</dd></dl>
35
36**[PCL]/include/pcl**
37
38<dl><dd>
39   Standard PCL C++ header files. These files are necessary for development of PixInsight modules.
40</dd></dl>
41
42**[PCL]/src/3rdparty**
43
44<dl><dd>
45   Some third-party libraries, mainly file format support libraries, used by the PixInsight modules included in this distribution. The CFITSIO, LibRAW and JasPer libraries may include custom modifications, which are conveniently identified in the source code (search for the 'CUSTOM CODE' string).
46</dd></dl>
47
48**[PCL]/src/modules/file-formats**
49
50<dl><dd>
51   Open-source PixInsight file format modules with complete source code.
52</dd></dl>
53
54**[PCL]/src/modules/processes**
55
56<dl><dd>
57   Open-source PixInsight process modules, with complete source code. These source codes are ready for compilation and form an excellent body of development reference material.
58</dd><dd>
59   On module subdirectories under the [PCL]/src/modules branch, we provide makefiles and project files that can be used to build and test the supplied modules; these files have been automatically generated by the standard Makefile Generator script in PixInsight. They can be regenerated with the same script to adapt the build process to the user requirements.
60</dd><dd>
61   For each [module_name] module, makefiles and projects are available on the following subdirectories:
62</dd></dl>
63
64**[PCL]/src/modules/file-formats/[module_name]/freebsd/g++**<br/>
65**[PCL]/src/modules/processes/[module_name]/freebsd/g++**
66
67<dl><dd>
68   Makefiles for FreeBSD 10 with the system clang C++ compiler
69</dd></dl>
70
71**[PCL]/src/modules/file-formats/[module_name]/linux/g++**<br/>
72**[PCL]/src/modules/processes/[module_name]/linux/g++**
73
74<dl><dd>
75   Makefiles for Linux with GCC >= 4.8.5 (GCC 7 or higher recommended)
76</dd></dl>
77
78**[PCL]/src/modules/file-formats/[module_name]/macosx/g++**<br/>
79**[PCL]/src/modules/processes/[module_name]/macosx/g++**
80
81<dl><dd>
82   Makefiles for macOS >= 10.9 with clang C++ compiler/Xcode version >= 5.0
83</dd></dl>
84
85**[PCL]/src/modules/file-formats/[module_name]/windows/vc15**<br/>
86**[PCL]/src/modules/processes/[module_name]/windows/vc15**
87
88<dl><dd>
89   Project files (.vcxproj) for Microsoft Visual C++ 2017
90</dd></dl>
91
92**[PCL]/src/pcl**
93
94<dl><dd>
95   The complete source code of PixInsight Class Library (PCL). Along with the PCL headers distributed on the [PCL]/include/pcl directory, you can use these source files with the provided makefiles and project files to rebuild PCL on your system.
96</dd></dl>
97
98
99## Supported Compilers
100
101The current version of PCL has been built and tested with:
102
103   * Red Hat Enterprise Linux 7.4: GCC C++ compiler 7.3.0.
104   * macOS 10.11: Clang C++ compiler with Xcode 8.2.1, as provided by Apple.
105   * Windows 10: Microsoft Visual C++ 2017 Community Edition.
106
107We are currently working on the port to FreeBSD:
108
109   * FreeBSD 10.4: System clang compiler.
110
111The GCC and clang C++ compilers provide higher conformance to ISO C++ standards and are high quality development tools. On FreeBSD and macOS we rely on the Clang/LLVM compiler included with the latest versions of Xcode and FreeBSD.
112
113On Windows, we provide project files for the Microsoft Visual Studio integrated development environment (.vcxproj files). As of PCL version 2.1.10, we support Visual C++ 2017 exclusively.
114
115
116## Environment Variables
117
118In order to use the PCL build system to compile and link PCL-based code, a number of environment variables must be defined on all platforms.
119
120With the following environment variables correctly defined, you can generate makefiles and project files for your modules on all platforms automatically with the Makefile Generator script, which we have included as a standard tool on all PixInsight core distributions.
121
122**PCLDIR**
123
124<dl><dd>
125   PCL root directory. The value of this variable must be the full directory path where the PCL distribution has been installed on your computer. On FreeBSD, Linux and macOS, this variable should normally be (assuming that you have installed PCL on a 'PCL' subdirectory of your home directory):
126</dd></dl>
127
128<dl><dd><dl><dd>
129   $HOME/PCL
130</dd></dl></dd></dl>
131
132<dl><dd>
133   and on Windows, something like:
134</dd></dl>
135
136<dl><dd><dl><dd>
137   C:\Users\[your-user-name]\PCL
138</dd></dl></dd></dl>
139
140<dl><dd>
141   or maybe something more practical such as:
142</dd></dl>
143
144<dl><dd><dl><dd>
145   C:\PCL
146</dd></dl></dd></dl>
147
148**PCLBINDIR32** (* Obsolete *)
149
150<dl><dd>
151   Binary files subdirectory for 32-bit executables and shared objects. This variable has been deprecated and is no longer necessary. PCL development on 32-bit platforms is no longer supported.
152</dd></dl>
153
154**PCLBINDIR64**
155
156<dl><dd>
157   Binary files subdirectory for 64-bit executables and shared objects. Normally this variable should be equal to $PCLDIR/bin.
158</dd></dl>
159
160**PCLBINDIR**
161
162<dl><dd>
163   PCL binaries directory. This variable should be equal to PCLBINDIR64.
164</dd></dl>
165
166**PCLLIBDIR32** (* Obsolete *)
167
168<dl><dd>
169   32-bit libraries subdirectory. This variable has been deprecated and is no longer necessary. PCL development on 32-bit platforms is no longer supported.
170</dd></dl>
171
172**PCLLIBDIR64**
173
174<dl><dd>
175   64-bit libraries subdirectory. This variable should normally be equal to $PCLDIR/lib/[platform]/x64 on each platform.
176</dd></dl>
177
178**PCLLIBDIR**
179
180<dl><dd>
181   PCL library files directory. This variable should normally be equal to PCLLIBDIR64.
182</dd></dl>
183
184**PCLINCDIR**
185
186<dl><dd>
187   PCL include files directory. Should normally be equal to $PCLDIR/include.
188</dd></dl>
189
190**PCLSRCDIR**
191
192<dl><dd>
193   PCL source files directory. Should normally be equal to $PCLDIR/src.
194</dd></dl>
195
196
197
198******
199###### Copyright (C) 2003-2019 Pleiades Astrophoto
200