diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,675 @@ + 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/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/bindings-saga-cmd.cabal b/bindings-saga-cmd.cabal new file mode 100644 --- /dev/null +++ b/bindings-saga-cmd.cabal @@ -0,0 +1,65 @@ +name: bindings-saga-cmd +version: 0.1.0.0 +synopsis: Wrapping saga_cmd +description: A simple wrapper around the command-line version of the GIS-program saga +homepage: https://github.com/michelk/bindings-saga-cmd.hs + +license: GPL-3 +license-file: LICENSE +author: Michel Kuhlmann +maintainer: michel.kuhlmann@tkconsult.ch +category: Math +build-type: Simple +cabal-version: >=1.8 + +source-repository head + type: git + location: https://github.com/michelk/bindings-saga-cmd.hs + +library + exposed-modules: Gis.Saga.Types + Gis.Saga.Cmd + Gis.Saga.Data + Gis.Saga.Utils + Gis.Saga.LUT + Gis.Saga.Doc + Gis.Saga.Node + build-depends: base >=4.3 && < 5, + filepath, + process, + containers, + directory, + unix + hs-source-dirs: src + +executable sagaPipe + main-is: sagaPipe.hs + build-depends: base >=4.3 && < 5, + filepath, + cmdargs, + process, + text, + containers, + directory, + unix, + bindings-saga-cmd + hs-source-dirs: src + +executable sagaTopo + main-is: sagaTopo.hs + build-depends: base >=4.3 && < 5, + filepath, + cmdargs, + process, + text, + containers, + directory, + unix, + bindings-saga-cmd + hs-source-dirs: src + +executable sagaLut + main-is: sagaLut.hs + build-depends: base >=4.3 && < 5, + bindings-saga-cmd + hs-source-dirs: src diff --git a/src/Gis/Saga/Cmd.hs b/src/Gis/Saga/Cmd.hs new file mode 100644 --- /dev/null +++ b/src/Gis/Saga/Cmd.hs @@ -0,0 +1,95 @@ +module Gis.Saga.Cmd where +import Data.Map (elems) +import qualified Data.Map as M +import Data.Maybe (fromMaybe, fromJust) +import GHC.IO.Exception +import Gis.Saga.Types +import Gis.Saga.Utils +import System.Process (system) +import System.Posix.Temp (mkdtemp) +import System.FilePath.Posix (replaceDirectory, joinPath) +import System.Directory (getTemporaryDirectory) + +-- | Actual Program to do the work +progName :: String +progName = "saga_cmd" + +-- | Call saga with a specific configuration +doSaga :: SagaCmd -> IO FilePath +doSaga (SagaCmd lib mod (kIn, kOut) ps maybePre maybePost fOut fIn) = do + pre fIn fOut + r <- saga lib mod (elems ps ++ [(kIn,fIn),(kOut,fOut)]) + case r of + ExitSuccess -> do + post fIn fOut + return fOut + ExitFailure _ -> error "saga_cmd failed" + where + pre = fromMaybe nthn maybePre + post = fromMaybe nthn maybePost + nthn _ _ = return () + + +-- | Wrapper around saga +saga :: + String -- ^ Library name + -> String -- ^ Module name + -> [(String,String)] -- ^ Parameter key-value + -> IO ExitCode -- ^ Output-file +saga lib mod params = + do putStrLn cmd + system cmd + where + renderParams = map renderPara + renderPara (k,v) = "-" ++ k ++ "=" ++ v + cmd = unwords [ + progName + ,lib + ,mod + ,unwords . renderParams $ params + ] + + +-- | adjust default parameters with the ones given on the command-line +adjustSagaCmdParas :: CmdPars -> SagaCmd -> SagaCmd +adjustSagaCmdParas cmdPrs cmd@(SagaCmd{sParas = libPrs}) = + cmd {sParas = adjustParas libPrs cmdPrs} + +-- | Overwrite default parameters with parameters given on the command-line +adjustParas :: ParaMap -- ^ parameters specified in 'SagaCmd' + -> CmdPars -- ^ parameters given on the cmd-line + -> ParaMap -- ^ adjusted parameters +adjustParas libPrs cmdPrs = M.mapWithKey lkp m' + where + -- | union of cmd-pars and lib-pars; this overwrites the defaults + m = M.union cmdPrs $ M.map snd libPrs + -- | select relevant pars + m' = M.filterWithKey (\k _ -> k `elem` M.keys libPrs) m + lkp k v = (fst $ fromJust (M.lookup k libPrs), v) + +-- | Execute a 'SagaIoCmdExt' +doCmdChain :: [SagaIoCmdExt] -> CmdPars -> FilePath -> Maybe FilePath -> IO FilePath +doCmdChain chain pars fIn fOut = do + let outFsDefault = tail $ scanl appendFileName fIn (map snd chain) + outFs <- case fOut of + Nothing -> return outFsDefault + Just f -> do + dtempDir <- getTemporaryDirectory + let dtempT = joinPath [dtempDir, "sagaPipe"] + dtemp <- mkdtemp dtempT + return $ map (`replaceDirectory` dtemp) (init outFsDefault) ++ [f] + let chain' = map (\(f,ext) -> f ext) $ zip (map fst chain) outFs + foldl (\fOut f -> do + fIn' <- fOut + doSaga . adjustSagaCmdParas pars . f $ fIn' + ) (return fIn) chain' + +-- | Lookup a chain +lkpChain :: SagaIoCmdDB -> [String] -> [SagaIoCmdExt] +lkpChain db = map (`lkpCmd` db) + +-- | Lookup a single command +lkpCmd :: String -> SagaIoCmdDB -> SagaIoCmdExt +lkpCmd s db = fromMaybe (error "Command is not yet implemented") $ M.lookup s db + + diff --git a/src/Gis/Saga/Data.hs b/src/Gis/Saga/Data.hs new file mode 100644 --- /dev/null +++ b/src/Gis/Saga/Data.hs @@ -0,0 +1,141 @@ +module Gis.Saga.Data where +import Gis.Saga.Types +import Gis.Saga.Utils +import System.Directory (removeFile) +import qualified Data.Map as M + +-- | Implemented command for piping +sIoDB :: SagaIoCmdDB +sIoDB = M.fromList [ + ("xyzGridToGrid", ( + SagaCmd "io_grid" "6" ("FILENAME","GRID") -- library, module, input-,output-parameters + (M.fromList [ -- parameters: sagaPipe-par, saga_cmd-par, default + ("cs", ("CELLSIZE" , "1")) + ,("sep", ("SEPARATOR" , "space")) + ]) + Nothing Nothing -- pre-, post-processing + , ".sgrd" -- output-file extension + ) + ) + ,("lasToPtCld", ( + SagaCmd "io_shapes_las" "1" ("FILE", "POINTS") + (M.fromList []) Nothing Nothing , ".spc")) + ,("ptCldToGrid", ( + SagaCmd "pointcloud_tools" "4" ("POINTS","GRID") + (M.fromList [ + ("cs", ("CELLSIZE" , "1")) + ]) + Nothing Nothing ,".sgrd")) + ,("gridFillGaps", ( + SagaCmd "grid_spline" "5" ("GRIDPOINTS","GRID_GRID") + (M.fromList [("grdFlT", ("TARGET", "1"))]) + (Just copyGrid) Nothing, "_filled.sgrd")) + ,("gridHillshade", ( + SagaCmd "ta_lighting" "0" ("ELEVATION","SHADE") + (M.fromList []) Nothing Nothing , "_hillshade.sgrd")) + ,("gridContour", ( + SagaCmd "shapes_grid" "5" ("INPUT","CONTOUR") + (M.fromList [ + ("min" , ("ZMIN" , "0")) + ,("max" , ("ZMAX" , "10000")) + ,("d", ("ZSTEP" , "1")) + ]) Nothing Nothing, "_contour.sgrd")) + ,("gridPolyClip", ( + SagaCmd "shapes_grid" "7" ("INPUT","OUTPUT") + (M.fromList [ + ("poly" , ("POLYGONS" , "1")) + ]) Nothing Nothing, "_polyClip.sgrd")) + ,("gridTifHillshade", ( + SagaCmd "io_grid_image" "0" ("GRID","FILE") + (M.fromList [ + ("pal" , ("COL_PALETTE", "2")) + ,("colRev",("COL_REVERT" , "1")) + ,("min",("STRETCH_MIN" , "0")) + ,("max",("STRETCH_MAX" , "1.571")) + --,("stddev",("STDDEV" , "2")) + --,("col",("COLOURING" , "2")) + ]) Nothing Nothing, ".tif")) + ,("gridTifTerrain", ( + SagaCmd "io_grid_image" "0" ("GRID","FILE") + (M.fromList [ + ("pal" , ("COL_PALETTE", "23")) + --,("colRev",("COL_REVERT" , "1")) + ,("min",("STRETCH_MIN" , "0")) + ,("max",("STRETCH_MAX" , "100")) + --,("stddev",("STDDEV" , "2")) + ,("col",("COLOURING" , "2")) + ]) Nothing Nothing, ".tif")) + ,("gridTifGdal", ( + SagaCmd "io_gdal" "2" ("GRIDS","FILE") + (M.fromList [ + ]) Nothing Nothing, ".tif")) + ,("gdalGrid", ( + SagaCmd "io_gdal" "0" ("FILES", "GRIDS") + (M.fromList [ + ]) Nothing Nothing, ".sgrd")) + ,("gridXyz", ( + SagaCmd "io_grid" "5" ("GRIDS","FILENAME") + (M.fromList [ + ]) Nothing Nothing, ".xyz")) + ,("polyDissolve", ( + SagaCmd "shapes_polygons" "5" ("POLYGONS","DISSOLVED") + (M.fromList [ + ("method" ,("DISSOLVE" , "0")) -- 0: polygons with same attribute value + -- 1: all polygons + -- 2: polygons with same attribute value (keep inner boundaries) + -- 3: all polygons (keep inner boundaries) + ,("f1",("FIELD_1" , "1")) + ,("f2",("FIELD_1" , "-1")) + ,("f3",("FIELD_1" , "-1")) + ]) + Nothing Nothing, "_disollved.shp")) + ,("gridSlope", ( + SagaCmd "ta_morphometry" "0" ("ELEVATION","SLOPE") + (M.fromList [ + ("aspect" ,("ASPECT" , "aspect")) + ]) + Nothing Nothing, "_slope.sgrd")) + ,("gridClassifyFlat", ( + SagaCmd "grid_tools" "15" ("INPUT","RESULT") + (M.fromList [ + ("method" ,("METHOD" , "2")) -- 1: range + -- 2: simple table + ,("table" ,("RETAB" , "reclassify.txt")) + ]) + (Just (\_ _ -> writeReclassifyTableFlatSlope "reclassify.txt")) + (Just (\_ _ -> removeFile "reclassify.txt")) + , "_reclassified.sgrd")) + ,("gridClassToPoly", ( + SagaCmd "shapes_grid" "6" ("GRID","POLYGONS") + (M.fromList [ + ("id", ("CLASS_ID" , "1")) -- class identifier + ,("all", ("CLASS_ALL" , "0")) -- 0: one single class specified by class identifier + -- 1: all classes + ,("split", ("SPLIT" , "0")) -- 0: one single (multi-)polygon object + -- 1: each island as separated polygon + ]) + Nothing Nothing, "_polygons.shp")) + ] + + +-- | Pathsway nodes with input and output commands +sNodes :: NodeMap +sNodes = + M.fromList [ + ("las", ([], ["lasToPtCld"])) + ,("gdal", ([], ["gdalGrid"])) + ,("ptc", (["lasToPtCld"], ["ptCldToGrid"])) + ,("grid", (["ptCldToGrid", "xyzGridToGrid", "gdalGrid"], + ["gridFillGaps", "gridTifGdal", "gridPolyClip" + ,"gridSlope", "gridClassToPoly", "gridClassifyFlat"])) + ,("xyz-grid", ([], ["xyzGridToGrid"])) + ,("grid-filled", (["gridFillGaps"], + ["gridHillshade", "gridXyz", "gridContour"])) + ,("grid-filled-hillshade", (["gridHillshade"], ["gridTifHillshade"])) + ,("grid-filled-hillshade-tif", (["gridTifHillshade"], [])) + ,("grid-hillshade", (["gridHillshade"], ["gridTifHillshade"])) + ,("grid-hillshade-tif", (["gridTifHillshade"], [])) + ,("grid-filled-xyz", (["gridXyz"], [])) + ,("grid-filled-contour", (["gridContour"], [])) + ,("grid-polygonClip", (["gridPolyClip"], [])) + ] diff --git a/src/Gis/Saga/Doc.hs b/src/Gis/Saga/Doc.hs new file mode 100644 --- /dev/null +++ b/src/Gis/Saga/Doc.hs @@ -0,0 +1,88 @@ +{-# LANGUAGE FlexibleInstances #-} +module Gis.Saga.Doc (renderTable, renderDot, renderNodes) +where +import qualified Data.Map as M +import Gis.Saga.Types +import Data.List (intercalate) +import Text.Printf (printf) + +class TableView a where renderTable :: a -> String + +instance TableView SagaIoCmdDB where + renderTable db = + "Command (cmdPar,sagaPar,default) sagaLib sagaModule defaultSuffix\n" ++ + (unlines . map renderTable . M.toList $ db) + +instance TableView (String, SagaIoCmdExt) where + renderTable = renderTableSagaIoCmd + +renderTableSagaIoCmd :: (String, SagaIoCmdExt) -> String +renderTableSagaIoCmd (cmdName, (cmd, ext)) = + let SagaCmd {sLib = lib, sMod = mod, sParas = ps } = cmd "" "" + in unwords [cmdName, renderTable ps, lib, mod, ext] + +instance TableView ParaMap where + renderTable pm + | M.size pm == 0 = "NA" + | otherwise = intercalate ":" (map renderTable . M.toList $ pm) + +instance TableView (String, (String,String)) where + renderTable (cmdArg, (sArg,def)) = + "(" ++ intercalate "," [cmdArg,sArg,def] ++ ")" + + + +class DotGraphics a where renderDot :: a -> String + +instance DotGraphics (SagaIoCmdDB,NodeMap) where + renderDot (cmds,chains) = unlines [ + "digraph chains {" + ," graph [rankdir = LR];" + ," node [shape = ellipse, fontsize = 8];" + ,"" + ,unlines . map renderDot . M.toList $ cmds -- implemented modules + ,renderDot chains -- implemented chains + ,"}" + ] + +instance DotGraphics (String, SagaIoCmdExt) where + renderDot = renderDotSagaIoCmd + +renderDotSagaIoCmd :: (String, SagaIoCmdExt) -> String +renderDotSagaIoCmd (cmdName, (cmd,ext)) = + let SagaCmd {sLib = lib, sMod = mod, sParas = ps } = cmd "" "" + in printf " %s [shape = record, label = \"%s|%s|%s|%s %s\"];" + cmdName cmdName (renderDot ps) ext lib mod + + +renderDotParaMap :: ParaMap -> String +renderDotParaMap pm = "{" ++ ss ++ "}" + where + ps = M.toList pm + cmdArgs = intercalate "\\n" (map fst ps) + sArgs = intercalate "\\n" (map (fst . snd) ps) + defs = intercalate "\\n" (map (snd . snd) ps) + ss = intercalate "|" [cmdArgs,sArgs,defs] + +instance DotGraphics ParaMap where + renderDot = renderDotParaMap + +instance DotGraphics NodeMap where + renderDot = unlines . map renderDot . M.toList + +instance DotGraphics (String, ([String],[String])) where + renderDot (name, (ins, outs)) = unlines $ map unlines [ + map (`edge` name) ins + ,map (name `edge`) outs + ] + +edge :: String -> String -> String +edge = printf " \"%s\" -> \"%s\";" + +class NodeView a where renderNodes :: a -> String + +instance NodeView NodeMap where + renderNodes = unlines . map renderNodes . M.toList + +instance NodeView (String, ([String], [String])) where + renderNodes (name, (ins, outs)) = name ++ ": "++ show ins ++ show outs diff --git a/src/Gis/Saga/LUT.hs b/src/Gis/Saga/LUT.hs new file mode 100644 --- /dev/null +++ b/src/Gis/Saga/LUT.hs @@ -0,0 +1,138 @@ +module Gis.Saga.LUT (bgrColTable) +where +import Data.List (zip5, intercalate) +import Text.Printf (printf) + +-- | Red-blue-green-colors +type RGB = (Int, Int, Int) + +-- | Create a color lookup-table based on minimum and maximum values +bgrColTable :: Float -> Float -> String +bgrColTable minV maxV = hd ++ unlines (map renderRec recs') + where + d = maxV - minV + s = d/fromIntegral n + minVs = take n [minV, (minV + s) ..] + maxVs = take n [(minV + s), (minV + 2*s) ..] + n :: Int + n = 100 + nms = take n $ map (\x -> "Class " ++ show x) [1..] + recs = zip5 bgr100 nms nms minVs maxVs + recs' = (8388864 :: Int, "Class 0", "Class 0", 0 :: Float, minV) : + recs ++ + [(391 ::Int , "Class 101", "Class 101", maxV, 10000 :: Float)] + renderRec (col,nm,desc,k,j)= printf "%7i\t%s\t%s\t%10.7f\t%10.7f" + col (quote nm) (quote desc) k j + quote s = "\"" ++ s ++ "\"" + hd = intercalate "\t" ["COLOR","NAME","DESCRIPTION","MINIMUM", "MAXIMUM"] ++ "\n" + + +-- | Convert a RGB-color to BGR-color +rgbToBgr :: RGB -> Int +rgbToBgr (r,g,b) = (b * 65536) + (g * 256) + r + +bgr100 :: [Int] +bgr100 = map rgbToBgr rgb100 + +rgb100 :: [RGB] +rgb100 = + [(000, 001, 128) + ,(000, 001, 135) + ,(000, 002, 143) + ,(000, 003, 151) + ,(000, 004, 159) + ,(000, 007, 167) + ,(000, 009, 174) + ,(000, 013, 182) + ,(000, 016, 189) + ,(000, 020, 196) + ,(000, 025, 202) + ,(000, 030, 208) + ,(000, 035, 214) + ,(000, 041, 220) + ,(000, 047, 225) + ,(000, 053, 230) + ,(000, 059, 235) + ,(000, 066, 239) + ,(000, 073, 242) + ,(000, 081, 246) + ,(000, 088, 248) + ,(000, 096, 251) + ,(000, 104, 252) + ,(000, 112, 253) + ,(000, 120, 254) + ,(001, 128, 255) + ,(001, 135, 254) + ,(002, 143, 253) + ,(003, 151, 252) + ,(004, 159, 251) + ,(007, 167, 248) + ,(009, 174, 246) + ,(013, 182, 242) + ,(016, 189, 239) + ,(020, 196, 235) + ,(025, 202, 230) + ,(030, 208, 225) + ,(035, 214, 220) + ,(041, 220, 214) + ,(047, 225, 208) + ,(053, 230, 202) + ,(059, 235, 196) + ,(066, 239, 189) + ,(073, 242, 182) + ,(081, 246, 174) + ,(088, 248, 167) + ,(096, 251, 159) + ,(104, 252, 151) + ,(112, 253, 143) + ,(120, 254, 135) + ,(128, 255, 127) + ,(135, 254, 120) + ,(143, 253, 112) + ,(151, 252, 104) + ,(159, 251, 096) + ,(167, 248, 088) + ,(174, 246, 081) + ,(182, 242, 073) + ,(189, 239, 066) + ,(196, 235, 059) + ,(202, 230, 053) + ,(208, 225, 047) + ,(214, 220, 041) + ,(220, 214, 035) + ,(225, 208, 030) + ,(230, 202, 025) + ,(235, 196, 020) + ,(239, 189, 016) + ,(242, 182, 013) + ,(246, 174, 009) + ,(248, 167, 007) + ,(251, 159, 004) + ,(252, 151, 003) + ,(253, 143, 002) + ,(254, 135, 001) + ,(255, 128, 001) + ,(254, 120, 000) + ,(253, 112, 000) + ,(252, 104, 000) + ,(251, 096, 000) + ,(248, 088, 000) + ,(246, 081, 000) + ,(242, 073, 000) + ,(239, 066, 000) + ,(235, 059, 000) + ,(230, 053, 000) + ,(225, 047, 000) + ,(220, 041, 000) + ,(214, 035, 000) + ,(208, 030, 000) + ,(202, 025, 000) + ,(196, 020, 000) + ,(189, 016, 000) + ,(182, 013, 000) + ,(174, 009, 000) + ,(167, 007, 000) + ,(159, 004, 000) + ,(151, 003, 000) + ,(143, 002, 000) + ,(135, 001, 000)] diff --git a/src/Gis/Saga/Node.hs b/src/Gis/Saga/Node.hs new file mode 100644 --- /dev/null +++ b/src/Gis/Saga/Node.hs @@ -0,0 +1,32 @@ +module Gis.Saga.Node (getAllRoutes) +where +import qualified Data.Map as M +import Gis.Saga.Types + +-- | find all possible edges between Nodes +findEdges :: NodeMap -> [((String,String),[String])] +findEdges nds = + [((fromNme,toNme),[o]) | (fromNme, (_, fromOuts)) <- M.toList nds + , (toNme, (toIns, _)) <- M.toList nds + , o <- fromOuts + , i <- toIns + , o == i + ] + + +-- | Get all possible routes for some nodes +getAllRoutes :: NodeMap -> [((String,String),[String])] +getAllRoutes = concat . findRoutes . findEdges + +-- | finds all possible routes +findRoutes :: [((String,String),[String])] -> [[((String,String),[String])]] +findRoutes [] = [] +findRoutes edgs = edgs : edgs' : findRoutes edgs' + where + edgs' = chainEdges edgs + chainEdges :: [((String,String),[String])] -> [((String,String),[String])] + chainEdges edges = + [((srcF,dstT), srcCmds ++ dstCmds) | ((srcF,srcT),srcCmds) <- edges + , ((dstF,dstT),dstCmds) <- edges + , srcT == dstF + ] diff --git a/src/Gis/Saga/Types.hs b/src/Gis/Saga/Types.hs new file mode 100644 --- /dev/null +++ b/src/Gis/Saga/Types.hs @@ -0,0 +1,32 @@ +module Gis.Saga.Types where +import qualified Data.Map as M + +-- | Parameters passed in with command-line +type CmdPars = M.Map String String + +-- | Information needed to call saga_cmd +data SagaCmd = SagaCmd { + sLib :: String -- ^ library to call + ,sMod :: String -- ^ module number + ,sInOutKey:: (String,String) -- ^ Keys to use for input and output + ,sParas :: ParaMap -- ^ Parameters in addition to input and output + ,sPre :: Maybe (FilePath -> FilePath -> IO ()) -- ^ Pre-processing (input/output-file) + ,sPost :: Maybe (FilePath -> FilePath -> IO ()) -- ^ Post-processing (input/output-file) + ,sOutFile :: FilePath -- ^ Output-file + ,sInFile :: FilePath -- ^ Input-file + } + +-- | Parameter-Map in a 'SagaCmd' +type ParaMap = M.Map String (String,String) + +-- | Saga Command which takes only one input-, and one output-file +type SagaIoCmd = FilePath -> FilePath -> SagaCmd + +-- | SagaIO-Command with output file extension +type SagaIoCmdExt = (SagaIoCmd, String) + +-- | Data-base with available Saga-Input-Output-commands +type SagaIoCmdDB = M.Map String SagaIoCmdExt + +-- | Node-map for form-to-combinations +type NodeMap = M.Map String ([String],[String]) diff --git a/src/Gis/Saga/Utils.hs b/src/Gis/Saga/Utils.hs new file mode 100644 --- /dev/null +++ b/src/Gis/Saga/Utils.hs @@ -0,0 +1,53 @@ +module Gis.Saga.Utils where +import Gis.Saga.Types +import qualified Data.Map as M +import System.FilePath.Posix (dropExtension, replaceExtension) +import System.Directory (copyFile, renameFile) +import Text.Printf (printf) + +defaultCmdPars :: SagaCmd -> [(String,String)] +defaultCmdPars (SagaCmd {sParas = ps}) = + map (\(k,(_,v)) -> (k,v)) (M.toList ps) + +-- | Copy a grid data-set +copyGrid :: FilePath -> FilePath -> IO () +copyGrid f t = mapM_ cp ["sgrd", "sdat", "mgrd"] + where + cp ext = copyFile (replaceExtension f ext) (replaceExtension t ext) + +-- | Move a grid data-set +moveGrid :: FilePath -> FilePath -> IO () +moveGrid f t = mapM_ cp ["sgrd", "sdat", "mgrd"] + where + cp ext = renameFile (replaceExtension f ext) (replaceExtension t ext) + +-- | Utility function to append to basename of a file-name +appendFileName :: FilePath -> String -> FilePath +appendFileName f s = dropExtension f ++ s + +-- | Dispatch on field seperator +-- dispSep :: String -> String +-- dispSep s = case s of +-- "space" -> "space" +-- "Space" -> "space" +-- " " -> "space" +-- "\t" -> "tabulator" +-- "tab" -> "tabulator" +-- "Tab" -> "tabulator" +-- "Tabulator" -> "tabulator" +-- ";" -> ";" +-- "," -> "," + +-- Render a list of string-tuple in two columns +renderStringPairs :: [(String, String)] -> String +renderStringPairs = concatMap renderPair + where + renderPair :: (String, String) -> String + renderPair (k,v) = twoCol k v + +-- | render two strings in two columns +twoCol :: String -> String -> String +twoCol = printf "\t%10s %10s\n" + +writeReclassifyTableFlatSlope :: String -> IO () +writeReclassifyTableFlatSlope f = writeFile f "minimum\tmaximum\tnew\n0.000000\t0.100000\t1.000000\n0.100000\t0.200000\t2.000000\n0.200000\t0.500000\t3.000000\n0.500000\t1.000000\t4.000000\n1.000000\t5.000000\t5.000000\n5.000000\t25.000000\t6.000000\n25.000000\t50.000000\t7.000000\n" diff --git a/src/sagaLut.hs b/src/sagaLut.hs new file mode 100644 --- /dev/null +++ b/src/sagaLut.hs @@ -0,0 +1,16 @@ +module Main where +import System.Environment (getArgs, getProgName) +import Control.Monad (when) +import Gis.Saga.LUT + +main :: IO () +main = do + args <- getArgs + prg <- getProgName + when (length args /= 2) (fail (usage prg)) + let k:j:[] = args + putStr $ bgrColTable (read k) (read j) + + +usage :: String -> String +usage p = "Usage: " ++ p ++ " min max" diff --git a/src/sagaPipe.hs b/src/sagaPipe.hs new file mode 100644 --- /dev/null +++ b/src/sagaPipe.hs @@ -0,0 +1,89 @@ +{-# LANGUAGE DeriveDataTypeable #-} +module Main where +import Control.Monad (when) +import System.Console.CmdArgs +import Gis.Saga.Types +import Gis.Saga.Data +import Gis.Saga.Utils +import Gis.Saga.Cmd +import Gis.Saga.Node (getAllRoutes) +import Gis.Saga.Doc +import Data.Text (split, pack, unpack, Text) +import qualified Data.Map as M +import Data.Maybe (fromJust, fromMaybe) +import System.Environment (getArgs, withArgs) +import System.Exit (exitSuccess) + + +main :: IO () +main = do + args <- getArgs + -- If the user did not specify any arguments, pretend as "--help" was given + opts <- (if null args then withArgs ["--help"] else id) (cmdArgs defaultOpts) + when (modules opts) (sequence_ [putStrLn (renderTable sIoDB), exitSuccess]) + when (dot opts) (sequence_ [putStrLn (renderDot (sIoDB,sNodes)), exitSuccess]) + when (nodes opts) (sequence_ [putStrLn (renderNodes sNodes), exitSuccess]) + when (null $ file opts) (error "Please specify an input-file") + let cmdPars = parseParamCmdString $ parameters opts + allChains = M.fromList . getAllRoutes $ sNodes + cmdChain = case chain opts of + "" -> lkpChain sIoDB (fromMaybe (error ("from-to-combination not supported.\n\nSupported:\n " ++ + (unlines . map show . M.toList $ allChains))) + (M.lookup (from opts, to opts) allChains)) + _ -> lkpChain sIoDB (splitStr ':' $ chain opts) + result <- doCmdChain cmdChain cmdPars (file opts) (case (output opts) of + "" -> Nothing + _ -> Just (output opts) + ) + putStrLn ("Succussfully created " ++ result ) + +_PROGRAM_NAME, _PROGRAM_VERSION, _PROGRAM_INFO, _PROGRAM_ABOUT, _COPYRIGHT :: String +_PROGRAM_NAME = "sagaPipe" +_PROGRAM_VERSION = "0.1.0.0" +_PROGRAM_INFO = _PROGRAM_NAME ++ " version " ++ _PROGRAM_VERSION +_COPYRIGHT = "GPL licensed; written by Michel Kuhlmann 2013" +_PROGRAM_ABOUT = "Convert Digital Elevation Models (DEM) to diffent formats" + +-- | Data structure for command line options. +data Opt = Opt + { + from :: String + , to :: String + , parameters :: String + , chain :: String + , output :: FilePath + , modules :: Bool + , dot :: Bool + , nodes :: Bool + , file :: FilePath + } deriving (Show, Data, Typeable) + +-- | Defaults for command-line options. +defaultOpts :: Opt +defaultOpts = Opt + { + from = def &= help "Source-format" + , to = def &= help "Target-format" + , parameters = def &= help "Conversion-Parameters; delimited by ':'(eg cs=0.5:sep=tabulator)" + , chain = def &= help "Conversion-pathway; delimited by ':'(eg cXyzGridToGrid:cGridFillGaps)" + , output = def &= help "Output-file (optional; no intermediate files preserved)" + , modules = def &= help "Create a table of implemented modules" + , dot = def &= help "Show implemented chains as a dot-graphics" + , nodes = def &= help "Show implemented nodes" + , file = def &= args &= typ "DEM-input-file" + } &= + program _PROGRAM_NAME &= + help _PROGRAM_ABOUT &= + summary (_PROGRAM_INFO ++ ", " ++ _COPYRIGHT) + +-- | Parse the command-line string specifying parameters +parseParamCmdString :: String -> CmdPars +parseParamCmdString "" = M.empty +parseParamCmdString s = M.fromList . map parseAssign . splitStr ':' $ s + where + parseAssign :: String -> (String,String) + parseAssign s = let k:v:[] = splitStr '=' s in (k,v) + +-- | Split a String on a certain delimiter +splitStr :: Char -> String -> [String] +splitStr c s = map unpack $ split (== c) (pack s) diff --git a/src/sagaTopo.hs b/src/sagaTopo.hs new file mode 100644 --- /dev/null +++ b/src/sagaTopo.hs @@ -0,0 +1,97 @@ +{-# LANGUAGE DeriveDataTypeable #-} +-- | Program to +module Main where +import Control.Monad (when) +import qualified Data.Map as M +import Gis.Saga.Cmd +import Gis.Saga.Data +import Gis.Saga.LUT +import Gis.Saga.Types +import Prelude hiding (min,max) +import System.Console.CmdArgs +import System.Environment (getArgs, withArgs) + +_PROGRAM_NAME, _PROGRAM_VERSION, _PROGRAM_INFO, _PROGRAM_ABOUT, _COPYRIGHT :: String +_PROGRAM_NAME = "sagaTopo" +_PROGRAM_VERSION = "0.1.0.0" +_PROGRAM_INFO = _PROGRAM_NAME ++ " version " ++ _PROGRAM_VERSION +_COPYRIGHT = "GPL licensed; written by Michel Kuhlmann 2013" +_PROGRAM_ABOUT = "Create create topographic maps out of gridded data" + +_COLOR_FILE :: FilePath +_COLOR_FILE = "relief-colors.txt" + +main :: IO () +main = do + cArgs <- getArgs + -- If the user did not specify any arguments, pretend as "--help" was given + opts <- (if null cArgs then withArgs ["--help"] else id) (cmdArgs defaultOpts) + when (output opts == "") (fail "Please specify an output-tif") + r <- case (hillshade opts, min opts, max opts) of + (True, 0.0, 0.0) -> sgrdToTopo (file opts) (output opts) Nothing Nothing + (False, 0.0, 0.0) -> sgrdToRelief (file opts) (output opts) Nothing Nothing + (True, _, _) -> sgrdToTopo (file opts) (output opts) (Just $ min opts) (Just $ max opts) + (False, _, _) -> sgrdToRelief (file opts) (output opts) (Just $ min opts) (Just $ max opts) + putStrLn ("Successfully created " ++ r) + +-- | Convert a grid-file into a topo graphic map +sgrdToTopo :: FilePath -> FilePath -> Maybe Float -> Maybe Float -> IO FilePath +sgrdToTopo fIn fOut Nothing Nothing = do + let hsF = "temp_hillshade.sgrd" + doSaga $ gridHillShade hsF fIn + doSaga $ SagaCmd "libio_grid_image" "0" ("GRID", "FILE") + (M.fromList [ + ("a",("SHADE", hsF)) + ]) + Nothing Nothing fOut fIn + +sgrdToTopo fIn fOut (Just min') (Just max') = do + let hsF = "temp_hillshade.sgrd" + doSaga $ gridHillShade hsF fIn + writeFile _COLOR_FILE (bgrColTable min' max') -- color-lookup-table + doSaga $ SagaCmd "libio_grid_image" "0" ("GRID", "FILE") + (M.fromList [ + ("a",("SHADE", hsF)) + ,("b", ("LUT", _COLOR_FILE)) + ]) + Nothing Nothing fOut fIn + +sgrdToRelief :: FilePath -> FilePath -> Maybe Float -> Maybe Float -> IO FilePath +sgrdToRelief fIn fOut Nothing Nothing = do + doSaga $ SagaCmd "libio_grid_image" "0" ("GRID", "FILE") + (M.fromList []) + Nothing Nothing fOut fIn + +sgrdToRelief fIn fOut (Just min') (Just max') = do + writeFile _COLOR_FILE (bgrColTable min' max') -- color-lookup-table + doSaga $ SagaCmd "libio_grid_image" "0" ("GRID", "FILE") + (M.fromList [ + ("b", ("LUT", _COLOR_FILE)) + ]) + Nothing Nothing fOut fIn + +-- | Data structure for command line options. +data Opt = Opt + {min :: Float + ,max :: Float + ,output :: FilePath + ,hillshade :: Bool + ,file :: FilePath + } deriving (Show, Data, Typeable) + +-- | Defaults for command-line options. +defaultOpts :: Opt +defaultOpts = Opt + {output = def &= typ "TIF" &= help "output-tif" + ,min = def &= help "minimum elevation-value (optional)" + ,max = def &= help "maximum elevation-value (optional)" + ,hillshade = def &= help "Should a hillshade be included" + ,file = def &= args &= typ "DEM-file.sgrd" + } &= + program _PROGRAM_NAME &= + help _PROGRAM_ABOUT &= + summary (_PROGRAM_INFO ++ ", " ++ _COPYRIGHT) + +gridHillShade :: SagaIoCmd +gridHillShade = fst $ lkpCmd "gridHillshade" sIoDB +