Packaged with setuputils.
authorW. Trevor King <wking@drexel.edu>
Wed, 17 Jun 2009 16:16:54 +0000 (12:16 -0400)
committerW. Trevor King <wking@drexel.edu>
Thu, 18 Jun 2009 00:15:12 +0000 (20:15 -0400)
12 files changed:
LICENSE [new file with mode: 0644]
MANIFEST.in [new file with mode: 0644]
Makefile [new file with mode: 0644]
README
gnuplot_getSurfPos.py [deleted file]
piezo/__init__.py [new file with mode: 0644]
piezo/x_piezo.py [moved from x_piezo.py with 100% similarity]
piezo/z_piezo.py [moved from z_piezo.py with 99% similarity]
piezo/z_piezo_utils.py [moved from z_piezo_utils.py with 75% similarity]
setup.py [new file with mode: 0644]
test_vib_analyze.py [deleted file]
veeco_header [new file with mode: 0644]

diff --git a/LICENSE b/LICENSE
new file mode 100644 (file)
index 0000000..94a9ed0
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,674 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ 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.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    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 <http://www.gnu.org/licenses/>.
+
+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:
+
+    <program>  Copyright (C) <year>  <name of author>
+    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
+<http://www.gnu.org/licenses/>.
+
+  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
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
diff --git a/MANIFEST.in b/MANIFEST.in
new file mode 100644 (file)
index 0000000..c75e0c1
--- /dev/null
@@ -0,0 +1 @@
+include LICENSE veeco_header
diff --git a/Makefile b/Makefile
new file mode 100644 (file)
index 0000000..21415b7
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,19 @@
+.PHONY : all check dist clean
+
+all : dummy_py
+
+dummy_py : setup.py piezo/*.py
+       python setup.py install --home=~
+       echo "dummy for Makefile dependencies" > $@
+
+check : all
+       echo "No checks currently implemented"
+
+dist :
+       python setup.py sdist
+       scp dist/piezo*tar.gz einstein:public_html/code/python/
+
+clean :
+       python setup.py clean
+       rm -rf build dist piezo.egg-info
+       rm -f dummy_py *.pyc
diff --git a/README b/README
index 7ce2cc936da7a5cfddf6c6e8938bb02f791535aa..16453ba58632ab749eb6c9789a4389cc9728a3b1 100644 (file)
--- a/README
+++ b/README
@@ -1,4 +1,57 @@
-python calibrate_raw.py ../comedi_simult_AIO/20080128/far_45.raw
+Python modules to control piezoelectric actuators.  Mostly a set of
+convenient wrappers around pycomedi calls for keeping track of the
+relevant calibration constants.  To get a feel for an `official' set
+of calibration constants, you can take a peek at veeco_header, which
+is the beginning of a saved Veeco NanoScope image file.  It lists the
+parameters used by the NanoScope during imaging.
 
-veeco_header is the beginning of a saved Nanoscope image file.
-It lists the parameters used by the Nanoscope during imaging.
+== Installation ==
+
+Non-Python dependencies (Debian packagename):
+  easy_install  (python-setuptools)
+  Numpy         (python-numpy)
+  Scipy         (python-scipy)
+  Matplotlib    (python-matplotlib)
+
+Piezo uses `setuptools' for installation.  Setuptools is basically an
+extension of the standard Python distutils package which supports
+automatic package dependency tracking.  The installation procedure
+should be (on Debian-esque systems)
+  # apt-get intall python-setuptools python-numpy python-scipy python-matplotlib
+  # easy_install -f http://www.physics.drexel.edu/~wking/code/python/ piezo
+
+There is one speedbump you might run into:
+  * an outdated version of easy_install (see ez_setup.py section)
+
+** ez_setup.py
+
+This package bundles
+  http://peak.telecommunity.com/dist/ez_setup.py
+to bootstrap setuputils installation on your machine (if neccessary).
+
+If the bootstrapping doesn't work, you may need to install a current version
+of setuptools.  On Debian-based systems `apt-get install python-setuptools'.
+Once you have *some* version of setuptools, upgrade with
+  easy_install -U setuptools
+
+For more information see
+  http://peak.telecommunity.com/DevCenter/EasyInstall
+  http://peak.telecommunity.com/DevCenter/setuptools#what-your-users-should-know
+
+
+== Usage ==
+
+See piezo/z_piezo_utils.py for some simple examples.
+
+
+== Licence ==
+
+This project is distributed under the GNU General Public Licence
+Version 3 or greater.  See LICENSE.
+
+
+== Author ==
+
+W. Trevor King
+wking@drexel.edu
+Copyright 2007, 2008
diff --git a/gnuplot_getSurfPos.py b/gnuplot_getSurfPos.py
deleted file mode 100755 (executable)
index 7983b92..0000000
+++ /dev/null
@@ -1,44 +0,0 @@
-#!/usr/bin/python
-#
-# Usage: gnu_z_peizo_getSurfPos <filename>
-#
-# Where <filename> contains the data in ascii pairs
-# followed by a blank line
-# followed by lines: 
-#  #Guess params: [A, B, C, D]
-#  #Fit params: [A, B, C, D]
-
-import os
-import sys
-
-def get_params_from_line (line) :
-    "'#BlaBlaBla: [123, 456, 7.89, -10]' -> (123, 456, 7.89, -10)"
-    array_and_tailing_bracket = line.split('[')[1]
-    array = array_and_tailing_bracket.split(']')[0]
-    nums = array.split(',')
-    return (nums[0], nums[1], nums[2], nums[3])
-
-def get_line_starting_with(filename, start_string) :
-    ln = len(start_string)
-    for line in file(filename).readlines() :
-        if line[0:ln] == start_string :
-            return line
-
-filename = sys.argv[1]
-x_data_col = 1 # gnuplot columns start with 1
-y_data_col = 3
-
-start_line = get_line_starting_with(filename, "#Guess params:")
-s0,s1,s2,s3 = get_params_from_line(start_line)
-fit_line = get_line_starting_with(filename, "#Fit params:")
-f0,f1,f2,f3 = get_params_from_line(fit_line)
-
-print ""
-print "start(x) =  x < %s  ?  (%s)+(%s)*x  :  (%s)+(%s)*(%s)+(%s)*(x-(%s))" \
-                  % (s2,    s0,s1,      s0,s1,s2,s3,   s2)
-print "set arrow from %s, graph 0 to %s, graph 1 nohead" % (s2, s2)
-print "fit(x)   =  x < %s  ?  (%s)+(%s)*x  :  (%s)+(%s)*(%s)+(%s)*(x-(%s))" \
-                  % (f2,    f0,f1,      f0,f1,f2,f3,   f2)
-print "set arrow from %s, graph 0 to %s, graph 1 nohead" % (f2, f2)
-print "plot '%s' using %d:%d, start(x), fit(x)" % (filename, x_data_col, y_data_col)
-
diff --git a/piezo/__init__.py b/piezo/__init__.py
new file mode 100644 (file)
index 0000000..4a490d7
--- /dev/null
@@ -0,0 +1,24 @@
+# calibcant - tools for thermally calibrating AFM cantilevers
+#
+# Copyright (C) 2007-2009 William Trevor King
+#
+# 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, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
+# 02111-1307, USA.
+#
+# The author may be contacted at <wking@drexel.edu> on the Internet, or
+# write to Trevor King, Drexel University, Physics Dept., 3141 Chestnut St.,
+# Philadelphia PA 19104, USA.
+
+VERSION = "0.2"
similarity index 100%
rename from x_piezo.py
rename to piezo/x_piezo.py
similarity index 99%
rename from z_piezo.py
rename to piezo/z_piezo.py
index 62ef00d3c09857c5ba11f3e3fb90419141330170..f2d948842cce03c408f4113686353f47028086dc 100644 (file)
@@ -36,7 +36,7 @@ LOG_DIR = '$DEFAULT$/z_piezo'
 
 # Hackish defaults for the calibcant.config module
 DEFAULT_GAIN = 20 # Vpiezo / Voutput
-DEFAULT_SENSITIVITY = 7.41 # nm_surface/Volt_piezo
+DEFAULT_SENSITIVITY = 6.790 # nm_surface/Volt_piezo (for S/N 4546EV piezo from 2009/01/09 calibration on 200nm deep pits, 10 um pitch Digital Instruments P/N 498-000-026)
 DEFAULT_ZERO_PHOTODIODE_BITS = 2**15
 DEFAULT_VPHOTO_IN_2_VOLTS = lambda vbits : (vbits-DEFAULT_ZERO_PHOTODIODE_BITS)/3276.8
 DEFAULT_VZP_OUT_2_VOLTS   = lambda vbits : (vbits-DEFAULT_ZERO_PHOTODIODE_BITS)/3276.8
similarity index 75%
rename from z_piezo_utils.py
rename to piezo/z_piezo_utils.py
index f80017fcf4c6e194c1b8ad5db9497266b9876ccf..7d4880280b168ef9709d14c4ca7595278872d325 100644 (file)
@@ -1,5 +1,6 @@
 TEXT_VERBOSE = False
-PYLAB_INTERACTIVE_VERBOSE = False
+PYLAB_INTERACTIVE = True
+PYLAB_VERBOSE = True
 BASE_FIG_NUM = 60
 LOG_DATA = True
 LOG_DIR = '$DEFAULT$/z_piezo_utils'
@@ -10,13 +11,38 @@ SLEEP_DURING_SURF_POS_AQUISITION = False # doesn't help
 from numpy import array, arange, ones, zeros, linspace, uint16, float, sin, cos, pi
 from scipy.stats import linregress
 import curses_check_for_keypress
-import fit
+import scipy.optimize
 import data_logger
 import time
 
-if PYLAB_INTERACTIVE_VERBOSE :
-    from pylab import figure, plot, title, legend, hold, subplot
-        
+_flush_plot = None
+_final_flush_plot = None
+_pylab = None
+def _dummy_fn(): pass
+
+def _import_pylab():
+    """Import pylab plotting functions for when we need to plot.  This
+    function can be called multiple times, and ensures that the pylab
+    setup is only imported once.  It defines the functions
+      _flush_plot() to be called after incremental changes,
+      _final_flush_plot(), to be called at the end of any graphical processing, and
+      _pylab, a reference to the pylab module."""
+    global _pylab
+    global _flush_plot
+    global _final_flush_plot
+    if _pylab == None :
+        import pylab as _pylab
+    if _flush_plot == None :
+        if PYLAB_INTERACTIVE :
+            _flush_plot = _pylab.draw
+        else :
+            _flush_plot = _pylab.show
+    if _final_flush_plot == None :
+        if PYLAB_INTERACTIVE :
+            _final_flush_plot = _pylab.draw
+        else :
+            _final_flush_plot = _dummy_fn
+
 class error (Exception) :
     pass
 class poorFit (error) :
@@ -25,7 +51,7 @@ class tooClose (error) :
     pass
 
 def moveToPosOrDef(zpiezo, pos, defl, step, return_data=False) :
-    if return_data or LOG_DATA or PYLAB_INTERACTIVE_VERBOSE :
+    if return_data or LOG_DATA or PYLAB_VERBOSE :
         aquire_data = True
     else :
         aquire_data = False
@@ -68,12 +94,14 @@ def moveToPosOrDef(zpiezo, pos, defl, step, return_data=False) :
     
     if zpiezo.setExternalZPiezo != None :
         zpiezo.setExternalZPiezo(zpiezo.pos_out2nm(zpiezo.curPos()))
-    if PYLAB_INTERACTIVE_VERBOSE :
-        figure(BASE_FIG_NUM)
+    if PYLAB_VERBOSE :
+        _import_pylab()
+        _pylab.figure(BASE_FIG_NUM)
         timestamp = time.strftime('%H%M%S')
-        plot(pos_array, def_array, '.', label=timestamp)
-        title('step approach')
-        legend(loc='best')
+        _pylab.plot(pos_array, def_array, '.', label=timestamp)
+        _pylab.title('step approach')
+        _pylab.legend(loc='best')
+        _flush_plot()
     if LOG_DATA :
         log = data_logger.data_log(LOG_DIR, noclobber_logsubdir=False,
                                    log_name="moveToPosOrDef")
@@ -91,20 +119,20 @@ def moveToPosOrDef(zpiezo, pos, defl, step, return_data=False) :
 def wiggleForInterferenceMin(zpiezo, wig_amp=20000, wig_freq=100,
                              plotVerbose=True) :
     "Output sin to measure interference"
-    if PYLAB_INTERACTIVE_VERBOSE or plotVerbose:
-        from pylab import figure, plot, title, hold, ion, ioff, draw, axes
+    if PYLAB_VERBOSE or plotVerbose:
+        _import_pylab()
     npoints = 1000
     scanfreq = wig_freq*npoints
     out = zeros((npoints,), dtype=uint16)
     for i in range(npoints) :
         out[i] = int(sin(4*pi*i/npoints)*wig_amp+32000)
         # 4 for 2 periods
-    if PYLAB_INTERACTIVE_VERBOSE or plotVerbose:
-        figure(BASE_FIG_NUM+1)
-        a = axes()
-        title('wiggle for interference')
-        hold(False)
-        p = plot(out, out, 'b.-')
+    if PYLAB_VERBOSE or plotVerbose:
+        _pylab.figure(BASE_FIG_NUM+1)
+        a = _pylab.axes()
+        _pylab.title('wiggle for interference')
+        _pylab.hold(False)
+        p = _pylab.plot(out, out, 'b.-')
     if LOG_DATA :
         log = data_logger.data_log(LOG_DIR, noclobber_logsubdir=False,
                                    log_name="wiggle")
@@ -113,19 +141,19 @@ def wiggleForInterferenceMin(zpiezo, wig_amp=20000, wig_freq=100,
         data = zpiezo.ramp(out, scanfreq)
         dmin = data["Deflection input"].min()
         dmax = data["Deflection input"].max()
-        if PYLAB_INTERACTIVE_VERBOSE or plotVerbose:
+        if PYLAB_VERBOSE or plotVerbose:
             p[0].set_ydata(data["Deflection input"])
             a.set_ylim([dmin,dmax])
-            draw()
+            _flush_plot()
         if LOG_DATA :
             log.write_dict_of_arrays(data)
-    if PYLAB_INTERACTIVE_VERBOSE or plotVerbose:
-        hold(True)
+    if PYLAB_VERBOSE or plotVerbose:
+        _pylab.hold(True)
 
 def getSurfPosData(zpiezo, maxDefl, textVerbose=False, plotVerbose=False) :
     "Measure the distance to the surface"
-    if plotVerbose and not PYLAB_INTERACTIVE_VERBOSE :
-        from pylab import figure, plot, title, legend, hold, subplot
+    if plotVerbose and not PYLAB_VERBOSE :
+        _import_pylab()
     origPos = zpiezo.curPos()
     # fully retract the piezo
     if TEXT_VERBOSE or textVerbose :
@@ -150,16 +178,16 @@ def getSurfPosData(zpiezo, maxDefl, textVerbose=False, plotVerbose=False) :
         ret3=zpiezo.ramp(out, 10e3)
         del(out)
         zpiezo.updateInputs()
-        if PYLAB_INTERACTIVE_VERBOSE or plotVerbose :
-            figure(BASE_FIG_NUM+2)
+        if PYLAB_VERBOSE or plotVerbose :
+            _pylab.figure(BASE_FIG_NUM+2)
             def plot_dict(d, label) :
                 print d.keys()
-                plot(d["Z piezo output"], d["Deflection input"], '.',label=label)
+                _pylab.plot(d["Z piezo output"], d["Deflection input"], '.',label=label)
             plot_dict(ret1, 'First retract')
             plot_dict(mtpod, 'Single step in')
             plot_dict(ret3, 'Return to start')
-            legend(loc='best')
-            title('Too close')
+            _pylab.legend(loc='best')
+            _pylab.title('Too close')
         raise tooClose, "Way too close!\n(highContactPos %d <= origPos %d)" % (highContactPos, origPos) 
     zpiezo.updateInputs()
     # fully retract the piezo again
@@ -230,17 +258,30 @@ def analyzeSurfPosData(ddict, textVerbose=False, plotVerbose=False, retAllParams
     if TEXT_VERBOSE or textVerbose :
         print "start Def %d, final def %d, start pos %d, final pos %d" % (startDef, finalDef, startPos, finalPos)
         print "Guessed params ", pstart
-    params = fit.fit(data=[data["Z piezo output"][dump_before_index:], data["Deflection input"][dump_before_index:]],
-                     model='bilinear', start=pstart, scale=scale)
+    def bilinear(x, params):
+        left_offset,left_slope,kink_position,right_slope = params
+        if x < kink_position:
+            y = left_offset + left_slope*x
+        else:
+            y = left_offset + left_slope*kink_position \
+                + right_slope*(x-kink_position)
+    def residual(p, y, x):
+        Y = bilinear(x, p)
+        return Y-y
+    leastsq = scipy.optimize.leastsq
+    params,cov,info,mesg,ier = leastsq(
+        residual, pstart,
+        args=(data["Deflection input"][dump_before_index:],
+              data["Z piezo output"][dump_before_index:]),
+        full_output=True, maxfev=10000)
     if TEXT_VERBOSE or textVerbose :
         print "Best fit parameters: ", params
 
-    if PYLAB_INTERACTIVE_VERBOSE or plotVerbose :
-        if plotVerbose and not PYLAB_INTERACTIVE_VERBOSE :
-            from pylab import figure, plot, title, legend, hold, subplot
-        figure(BASE_FIG_NUM+3)
+    if PYLAB_VERBOSE or plotVerbose :
+        _import_pylab()
+        _pylab.figure(BASE_FIG_NUM+3)
         def plot_dict(d, label) :
-            plot(d["Z piezo output"], d["Deflection input"], '.',label=label)
+            _pylab.plot(d["Z piezo output"], d["Deflection input"], '.',label=label)
         try :
             plot_dict(ddict['ret1'], 'First retract')
             plot_dict(ddict['mtpod'], 'Single step in')
@@ -257,12 +298,13 @@ def analyzeSurfPosData(ddict, textVerbose=False, plotVerbose=False, retAllParams
                 return params[0] + params[1]*x
             else :
                 return params[0] + params[1]*params[2] + params[3]*(x-params[2])
-        plot([startPos, params[2], finalPos],
-             [fit_fn(startPos, params), fit_fn(params[2], params), fit_fn(finalPos, params)],
-             '-',label='fit')
-        title('surf_pos %5g %5g %5g %5g' % (params[0], params[1], params[2], params[3]))
-        legend(loc='best')
-
+        _pylab.plot([startPos, params[2], finalPos],
+                    [fit_fn(startPos, params), fit_fn(params[2], params), fit_fn(finalPos, params)],
+                    '-',label='fit')
+        _pylab.title('surf_pos %5g %5g %5g %5g' % (params[0], params[1], params[2], params[3]))
+        _pylab.legend(loc='best')
+        _flush_plot()
+    
     # check that the fit is reasonable
     # params[1] is slope in non-contact region
     # params[3] is slope in contact region
@@ -307,15 +349,16 @@ def test_smoothness(zp, plotVerbose=True) :
         outdata.append(out)
     if plotVerbose :
         from pylab import figure, plot, title, legend, hold, subplot        
-    if PYLAB_INTERACTIVE_VERBOSE or plotVerbose :
-        figure(BASE_FIG_NUM+4)
+    if PYLAB_VERBOSE or plotVerbose :
+        _import_pylab()
+        _pylab.figure(BASE_FIG_NUM+4)
         for i in range(10) :
-            plot(indata[i]['Z piezo output'],
-                 indata[i]['Deflection input'], '+--', label='in')
-            plot(outdata[i]['Z piezo output'],
-                 outdata[i]['Deflection input'], '.-', label='out')
-        title('test smoothness (step in, ramp out)')
-        #legend(loc='best')
+            _pylab.plot(indata[i]['Z piezo output'],
+                        indata[i]['Deflection input'], '+--', label='in')
+            _pylab.plot(outdata[i]['Z piezo output'],
+                        outdata[i]['Deflection input'], '.-', label='out')
+        _pylab.title('test smoothness (step in, ramp out)')
+        #_pylab.legend(loc='best')
     
 def test() :
     import z_piezo
@@ -327,3 +370,5 @@ def test() :
     if TEXT_VERBOSE :
         print "Surface at %g nm", pos
     print "success"
+    if PYLAB_VERBOSE and _final_flush_plot != None:
+        _final_flush_plot()
diff --git a/setup.py b/setup.py
new file mode 100644 (file)
index 0000000..1ffb1d8
--- /dev/null
+++ b/setup.py
@@ -0,0 +1,69 @@
+"""Piezo: tools for controlling piezoelectric actuators
+
+Requires
+  * pycomedi
+  * data_logger
+  * curses_check_for_keypress
+
+Git repository:
+http://www.physics.drexel.edu/~wking/code/git/piezo.git
+"""
+
+classifiers = """\
+Development Status :: 2 - Pre-Alpha
+Intended Audience :: Developers
+Intended Audience :: Science/Research
+Operating System :: POSIX
+Operating System :: Unix
+License :: OSI Approved :: GNU General Public License (GPL)
+Programming Language :: Python
+Topic :: Scientific/Engineering
+Topic :: Software Development :: Libraries :: Python Modules
+"""
+
+# http://peak.telecommunity.com/DevCenter/setuptools#using-setuptools-without-bundling-it
+import ez_setup
+ez_setup.use_setuptools()
+
+from setuptools import setup, find_packages
+
+# patch distutils if it can't cope with the "classifiers" or
+# "download_url" keywords
+from sys import version
+if version < '2.2.3':
+    from distutils.dist import DistributionMetadata
+    DistributionMetadata.classifiers = None
+    DistributionMetadata.download_url = None
+
+import piezo
+VERSION = piezo.VERSION
+
+doclines = __doc__.split("\n")
+
+setup(name="piezo",
+      version=VERSION,
+      maintainer="W. Trevor King",
+      maintainer_email="wking@drexel.edu",
+      url = "http://www.physics.drexel.edu/~wking/code/python/",
+      download_url = "http://www.physics.drexel.edu/~wking/code/python/piezo-%s.tar.gz" % VERSION,
+      license = "GNU General Public License (GPL)",
+      platforms = ["all"],
+      description = doclines[0],
+      long_description = "\n".join(doclines[2:]),
+      classifiers = filter(None, classifiers.split("\n")),
+      py_modules = ['ez_setup'],
+      packages = find_packages(),
+      dependency_links = [
+        "http://www.physics.drexel.edu/~wking/code/python/"
+        ],
+      install_requires = ['pycomedi >= 0.2', 
+                          'data_logger >= 0.2',
+                          'curses_check_for_keypress'],
+      )
+
+# use packages to include subdirectory packages
+# use py_modules to include single-module packages
+# use ext_modules to include extension modules
+# see
+#   http://www.python.org/doc/2.5.2/dist/listing-modules.html
+#   http://www.python.org/doc/2.5.2/dist/describing-extensions.html
diff --git a/test_vib_analyze.py b/test_vib_analyze.py
deleted file mode 100644 (file)
index b9c7a20..0000000
+++ /dev/null
@@ -1,8 +0,0 @@
-import sys
-import calibrate_cantilever
-
-tweak_file = sys.argv[1]
-
-calibrate_cantilever.PYLAB_INTERACTIVE = False
-calibrate_cantilever.vib_load_analyze_tweaked(tweak_file, plotVerbose=True)
-calibrate_cantilever._final_flush_plot()
diff --git a/veeco_header b/veeco_header
new file mode 100644 (file)
index 0000000..76c95a6
--- /dev/null
@@ -0,0 +1,187 @@
+\*File list\r\r
+\Version: 0x04320003\r\r
+\Date: 07:58:34 PM Thu Jan 24 2008\r\r
+\Start context: OL2\r\r
+\Data length: 20480\r\r
+\Text: \r\r
+\History: \r\r
+\*Equipment list\r\r
+\Description: MultiMode\r\r
+\Microscope: MultiMode\r\r
+\Scanner file: xxxxjv.scn\r\r
+\Profile name: tapping\r\r
+\*Scanner list\r\r
+\Scanner type: AFM\r\r
+\Serial number: 2253E\r\r
+\Piezo size: J\r\r
+\File name: xxxxjv.scn\r\r
+\Motor sensitivity factor: 4.22\r\r
+\Extended offset der: 10\r\r
+\Allow rotation: Allow\r\r
+\Piezo cal: 440\r\r
+\X sensitivity: 24.2844\r\r
+\X derate: 0.0348382\r\r
+\X mag: 1.18\r\r
+\X mag1: 0.629978\r\r
+\X arg: 2.66\r\r
+\X round: 0\r\r
+\Orthogonality: 0.000490434\r\r
+\Y sensitivity: 25.1192\r\r
+\Y derate: 0.0430099\r\r
+\Y mag: 1.18\r\r
+\Y mag1: 0.69\r\r
+\Y arg: 2.66\r\r
+\X slow sensitivity: 23.0255\r\r
+\X slow derate: 0.0521033\r\r
+\Y fast sensitivity: 24.1992\r\r
+\Y fast derate: 0.0348406\r\r
+\X slow-fast coupling: 0.0858568\r\r
+\X slow-fast coupling derating: 7.47671e-005\r\r
+\Y slow-fast coupling: 0.0766677\r\r
+\Y slow-fast coupling derating: 2.59931e-005\r\r
+\Fast cal freq: 6.10352\r\r
+\Slow cal freq: 11.9209\r\r
+\Xs-Yf coupling: 0.0207309\r\r
+\Xs-Yf coupling derating: 4.40664e-005\r\r
+\Ys-Xf coupling: 0.0208056\r\r
+\Ys-Xf coupling derating: 2.10055e-005\r\r
+\X offset sens: 26.6\r\r
+\Y offset sens: 27.72\r\r
+\@Sens. Zscan: V 7.900000 nm/V\r\r
+\@Sens. Current: V 10.00000 nA/V\r\r
+\*Ciao scan list\r\r
+\Parameter select: Main\r\r
+\Operating mode: Image\r\r
+\Tip serial number: \r\r
+\Scan size: 11000 nm\r\r
+\X offset: 1739.85 nm\r\r
+\Y offset: 2413.57 nm\r\r
+\Rotate Ang.: 0\r\r
+\Samps/line: 256\r\r
+\Lines: 256\r\r
+\Y disable: Enabled\r\r
+\Aspect ratio: 1:1\r\r
+\Bidirectional scan: Disabled\r\r
+\Scan line shift: 0\r\r
+\Scan rate: 1.00058\r\r
+\Minimum scan rate: 0.02\r\r
+\Lift rate: 4\r\r
+\X drift: 0\r\r
+\Y drift: 0\r\r
+\Step XY size: 300\r\r
+\Cycles: 10\r\r
+\Step XY period: 0.005\r\r
+\Step size: 3\r\r
+\Units: Metric\r\r
+\Color table: 12\r\r
+\Scope dualtrace: Dual\r\r
+\Auto X Sep: 0\r\r
+\Auto Y Sep: 0\r\r
+\Auto pattern: Linear\r\r
+\Auto number: 2\r\r
+\Capture direction: Up\r\r
+\Capture prelines: 50\r\r
+\FM igain: 100\r\r
+\FM pgain: 100\r\r
+\Engage Setpoint: 1\r\r
+\Drive feedback: Disabled\r\r
+\Drive time: 5\r\r
+\Drive setpoint: 2\r\r
+\Drive gain: 3.82821\r\r
+\@InterleaveList: S [InterleaveOffMode] "Disabled"\r\r
+\@MicroscopeList: S [TMMode] "Tapping"\r\r
+\@2:SPMFeedbackList: S [SPMFb] "Amplitude"\r\r
+\@3:SPMFeedbackList: S [SPMFb] "Amplitude" linked\r\r
+\@Sens. Deflection: V 1.000000 \r\r
+\@Sens. Friction: V 1.000000 \r\r
+\@Sens. Amplitude: V 1.000000 \r\r
+\@Sens. Aux A: V 1.000000 \r\r
+\@Sens. Aux B: V 1.000000 \r\r
+\@Sens. Aux C: V 1.000000 \r\r
+\@Sens. Aux D: V 1.000000 \r\r
+\@Sample period: V (0.1000000 us/LSB) 16.00000 us\r\r
+\@1:Z limit: V [Sens. Zscan] (0.006713867 V/LSB) 440.0000 V\r\r
+\@1:DeflectionLimit: V (20.00000 V/LSB) 2.500000 V\r\r
+\@1:AmplitudeLimit: V (20.00000 V/LSB) 20.00000 V\r\r
+\@Lift start height: V [Sens. Zscan] (0.006713765 V/LSB)       0 V\r\r
+\@Lift scan height: V [Sens. Zscan] (0.006713765 V/LSB)       0 V\r\r
+\@Drive height: V [Sens. Zscan] (0.006713765 V/LSB)       0 V\r\r
+\@2:AFMSetDeflection: V (0.0003051758 V/LSB) 1.825000 V\r\r
+\@3:AFMSetDeflection: V (0.0003051758 V/LSB) 1.000000 V linked\r\r
+\@2:TMSetAmplitude: V (0.0003051758 V/LSB) 0.5429077 V\r\r
+\@3:TMSetAmplitude: V (0.0003051758 V/LSB) 2.000000 V linked\r\r
+\@2:TMSetDeflection: V (0.0003051758 V/LSB)       0 V\r\r
+\@3:TMSetDeflection: V (0.0003051758 V/LSB) 1.000000 V linked\r\r
+\@2:STMSetCurrent: V [Sens. Current] (0.0003051758 V/LSB) 10.00000 V\r\r
+\@3:STMSetCurrent: V [Sens. Current] (0.0003051758 V/LSB) 10.00000 V\r\r
+\@2:SPMFbIgain: V (0.03125000 1/LSB) 0.5871795 \r\r
+\@3:SPMFbIgain: V (0.03125000 1/LSB) 2.000000  linked\r\r
+\@2:SPMFbPgain: V (0.03125000 1/LSB) 0.6265551 \r\r
+\@3:SPMFbPgain: V (0.03125000 1/LSB) 4.000000  linked\r\r
+\@2:SPMFbSgain: V (0.0000305176 1/LSB)       0 \r\r
+\@3:SPMFbSgain: V (0.0000305176 1/LSB)       0  linked\r\r
+\@2:Drive frequency: V (0.0000058208 kHz/LSB) 279.0184 kHz\r\r
+\@3:Drive frequency: V (0.0000058208 kHz/LSB) 300.0000 kHz linked\r\r
+\@2:Drive amplitude: V (0.6103516 mV/LSB) 8.739997 mV\r\r
+\@3:Drive amplitude: V (0.6103516 mV/LSB) 200.0000 mV linked\r\r
+\@2:Bias: V (0.3051758 mV/LSB)       0 mV\r\r
+\@3:Bias: V (0.3051758 mV/LSB)       0 mV\r\r
+\@2:Analog 1: V (0.0003051758 V/LSB)       0 V\r\r
+\@3:Analog 1: V (0.0003051758 V/LSB)       0 V\r\r
+\@2:Analog 2: V (0.0003662109 V/LSB)       0 V\r\r
+\@3:Analog 2: V (0.0003662109 V/LSB)       0 V\r\r
+\*Ciao image list\r\r
+\Data offset: 20480\r\r
+\Data length: 131072\r\r
+\Bytes/pixel: 2\r\r
+\Start context: OL\r\r
+\Data type: AFM\r\r
+\Note: \r\r
+\Plane fit: 701 -2799 2998.25 2\r\r
+\Frame direction: Down\r\r
+\Samps/line: 256\r\r
+\Number of lines: 256\r\r
+\Aspect ratio: 1:1\r\r
+\Scan size: 11 11 ~m\r\r
+\Scan line: Main\r\r
+\Line direction: Trace\r\r
+\Highpass: 0\r\r
+\Lowpass: 0\r\r
+\Realtime planefit: Line\r\r
+\Offline planefit: Full\r\r
+\Valid data start X: 0\r\r
+\Valid data start Y: 0\r\r
+\Valid data len X: 256\r\r
+\Valid data len Y: 256\r\r
+\@2:Image Data: S [Height] "Height"\r\r
+\@Z magnify: C [2:Z scale] 0.2830952 \r\r
+\@2:Z scale: V [Sens. Zscan] (0.006713765 V/LSB) 22.35684 V\r\r
+\@2:Z offset: V [Sens. Zscan] (0.006713765 V/LSB)       0 V\r\r
+\*Ciao image list\r\r
+\Data offset: 151552\r\r
+\Data length: 131072\r\r
+\Bytes/pixel: 2\r\r
+\Start context: OL\r\r
+\Data type: AFM\r\r
+\Note: \r\r
+\Plane fit: -11 1 4.25 2\r\r
+\Frame direction: Down\r\r
+\Samps/line: 256\r\r
+\Number of lines: 256\r\r
+\Aspect ratio: 1:1\r\r
+\Scan size: 11 11 ~m\r\r
+\Scan line: Main\r\r
+\Line direction: Trace\r\r
+\Highpass: 0\r\r
+\Lowpass: 0\r\r
+\Realtime planefit: Line\r\r
+\Offline planefit: Full\r\r
+\Valid data start X: 0\r\r
+\Valid data start Y: 0\r\r
+\Valid data len X: 256\r\r
+\Valid data len Y: 256\r\r
+\@2:Image Data: S [Amplitude] "Amplitude"\r\r
+\@Z magnify: C [2:Z scale] 1.456356 \r\r
+\@2:Z scale: V [Sens. Amplitude] (0.0003051758 V/LSB) 0.4119873 V\r\r
+\@2:Z offset: V [Sens. Amplitude] (0.0003051758 V/LSB)       0 V\r\r
+\*File list end\r\r