Package: femtoapiwrap
ContentsThis project contains a Python wrapper for calling theFemto APIfunctions
of MESc software and additional utilities for handling the data obtained from
the API.
These are bundled in thefemtoapiwrappackage that gets installed using
basic setup.For sample implementations for basic use cases, see the scripts in folderexamples/basic.Modules (it’s enough to importfemtoapiwraponly):femtoapiwrap.api: the low-level API functionsfemtoapiwrap.hi: high-level types and methodsfemtoapiwrap.utils: miscellaneous functionsfemtoapiwrap.errors: custom exceptionsInstallBasic Setup$cd<project-root>$pipinstall-U.Checking version:importfemtoapiwrapprint(femtoapiwrap.__version__)Running ExamplesExamples require additional dependencies, which can be installed like this:$pipinstall-U.[examples]Generating Documentation$cd<project-root>$pipinstall-U.[doc]$cddoc$makeclean$makehtmlThen you can find the documentation at<project-root>/doc/_build/index.html.
Rebuilding often requires the deletion of<project-root>/doc/parts/stubstoo.Running TestsRun tests with coverage report:$cd<project-root>$pipinstall.[test]$cd<project-root>/tests$coveragerun--sourcefemtoapiwrap-munittestdiscover&&coveragereportSome test cases need an accessible microscope or a running measurement.
By default, these are skipped and can be activated by setting1to the
environment variablesFEMTOAPIWRAP_TEST_MICROSCOPEorFEMTOAPIWRAP_TEST_ONLINErespectively.PurchaseTo purchase FemtoAPI please contactsales@femtonics.eu.DisclaimerIN NO EVENT SHALL FEMTONICS BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL,
INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE
USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF FEMTONICS HAS BEEN ADVISED
OF THE POSSIBILITY OF SUCH DAMAGE.FEMTONICS SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
THE SOFTWARE AND ACCOMPANYING DOCUMENTATION, IF ANY, PROVIDED HEREUNDER IS
PROVIDED “AS IS”. FEMTONICS HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT,
UPDATES, ENHANCEMENTS, OR MODIFICATIONS.Changelog0.5.2hi.UnitMetaNew attributest_step_in_ms,t_length_in_ms,t_length_in_ms_actual,file_handleandfs.hi.Roi.from_treeFixed loading optional fields (e. g.viewport_index).0.5.1hi.HighFemtoApi.read_pointsFix: no longer raisesEmptyJsonErrorwhen there are no points in the file.hi.Roi.to_px_coordsNew parameterclosed, with plotting example0.5.0hi.Point.from_px_coordsSupport for 3D points as well.hi.RoiBreaking change:removed attributesviewport_rotandviewport_transldue to expected removal from FemtoAPI JSON object.New attributesfirst_z_planeandlast_z_planefor planned
support of ROIs in zStack measurements (not yet implemented in MESc).hi.Roi.from_px_coordsBreaking change:replaced parameterviewportwithviewport_index.hi.Roi.to_treeBreaking change:removed parameters as the corresponding tree fields
can be filled from the attributes.hi.{FileMeta,SessionMeta}.from_treeTemporary fix to allow converted old MESc files pass the version validation.0.4.0errors.*Breaking changes:Exceptions are no longer inherited fromIOErroras that was merged withOSErrorandFemtoApiWrapErrorsubclasses
do not strictly related to OS error codes.PEP-8 compliant and more informative naming:ConnectionFailed->ApiConnectionErrorMicroscopeTimedOut->MeasurementTimeoutErrorNodeNotFound->NodeNotFoundErrorNoMetaData->EmptyJsonErrorInvalidDimension->DimensionErrorInvalidPointGroup->PointSeriesKeyErrorUnsupportedVersion->JsonVersionErrorerrors.ApiCommandErrorNew exception to contain error information about FemtoAPI command failures.errors.ApiLoginErrorNew exception.errors.NoMeasurementUnitRemoved, merged withNodeNotFoundErrorerrors.InvalidMeasurementTypeRemoved, it was unused.0.3.1hi.RoiAdded attributebackgroundbased on the previously unprocessed
JSON-attribute"role".hi.Roi.from_px_coordsAdded parameterbackground.0.3.0hi.HighFemtoApi.online_framesFixed to take into account the actual number of frames received from MESc.Breaking change:The actual start index is now included in the iterator.
Introduced the parameterstrictto enforce chunks of equal length.0.2.0.post1Relaxed dependency version requirements.0.2.0Initial public release.