Menu
▾
▴
Tree [7592f0] master / History
Read Me
Batch PIE
=========
Batch PIE (Batch Pipelined Image Editor) is an open source tool for a flexible
image editor with a batch processing feature for reliable editing of multiple
pictures.
- please refer to http://sourceforge.net/p/batchpie/ for extensive
documentation and information.
VERSION
=======
0.5.5 (2019-07-24, alpha version)
AUTHORS AND CONTRIBUTORS
========================
Author: Andreas Schwarzkopf
Contributors (details see commit log on the project page):
- Alexander Merkel (2016)
For contact refer to the URL above.
Third party libraries packaged in the binaries:
* JUnit
LICENSE
=======
Batch PIE is licensed under the terms of the GNU Lesser General Public License
v3. See "COPYING" and "COPYING.LESSER".
CONTACT
=======
If you have questions, comments, problems or find Bugs, contact us using:
* The application's forum on http://sourceforge.net/p/batchpie/
INSTALLING
==========
You have several options for installing Batch PIE.
* Install Java.
* Windows: Refer to downloads of www.oracle.com
* You can disable java content for webpages in settings.
* Linux: Install the package openjdk-7-jre
* Configure Batch PIE:
* Copy the runnable jar file to the folder of your desire. This is a
standalone executable file.
* If you use Linux, open the jar file properties using e. g. dolphin or
nautilus and mark it as executable.
* Starting using the command line use: java -jar *.jar
* Launch the application.
BUILDING
========
As you currently read this README, we presume that you already have the source.
If not, check http://sourceforge.net/p/batchpie. You can download
source archives there.
Required Dependencies:
----------------------
* eclipse
* openjdk-7-jdk (>= 7)
* maven
Compilation:
------------
If you have installed all required third party libs, you can compile Batch PIE
by using the runnable jar export of Eclipse:
* Copy the project folder to your Eclipse workspace folder. The project
folder contains "src", "test", COPYING, README, changelog etc.
* Run "mvn clean install" to generate a runnable jar file in the sub
folder target.
* Import as Maven project.
* Run the class net.sourceforge.batchpie.main.Launcher in order to debug.
* You need no other files to export to make the program run. The
configurations file is created launching the program. The program binary
can be distributed copying that single runnable jar file.
BINARY DISTRIBUTION
===================
If you have received Easy Folder Morpher in binary form, you can always acquire
the code at http://sourceforge.net/p/batchpie/ or from your distributor.
In the provided binary packages, included open source, third-party libraries
are provided (section AUTHORS AND CONTRIBUTORS). The licenses are
re-distributed along the libraries. Its source code was not modified. However,
you can get the sources from the addresses that are noted in Section AUTHORS
AND CONTRIBUTORS.
USING
=====
After starting Batch PIE, press "Help" to get an introductory help. More
information is available online at www.sourceforge.net/p/batchpie/
USAGE EXAMPLES
==============
Editing a single image without a batch process:
1. Add filter /Image/File operations/Image opener.
a) Double click on filter in the appearing box to configure it.
b) Browse a path and select an input image. Alternatively drop an image
file from a file browser directly on the "Input path" field.
2. Add filter /Image/Transform/Resize.
a) Drag with the left mouse button the red box (output) of the image
opener filter to the upper red box (input) of the resize filter to
assign the data source of the resize filter.
b) Apply also on the second filter a double click to configure it.
c) Set both for width and height factors 0.5.
d) Changes are applied either after pressing enter when entering a number
or after closing the configuration window.
3. Add filter /Image/Inspection/Image display.
a) Assign the resize filter data input using the output of the resizer.
b) Make a double click to preview the data.
c) Alter the zoom level to your desired factor.
e) Reconfiguring the resizer filter will automatically reload the
depending filters and also the display filter.
4. Add /Image/File operations/Image saver.
a) Assign the resizer as data source for it. Note that multiple inputs
can be connected to an output.
b) Configure this filter by browsing the target folder pressing on "..."
in the output path field and browse to the target directory of your
wish. Do also enter the image file name and press open or the return
button.
5. Execute the process of all saving modules using either "Run all" or "Run
selected" in the main frame.
6. If you have connections that you want to disconnect, simply press on an
input connector.
7. Save the project to restore the configuration in future.
Applying a batch process to edit multiple images:
1. Load the project that you saved in the single image editing.
a) Find a folder on your computer with multiple image files to use it as
input directory.
b) Press on "..." on the main window and navigate to the input directory.
You can also drop a folder from the file browser on the field.
c) Configure the Image opener selecting the input directory instead a
particular path.
d) Within the image saver, use also a directory. Make sure that you
select not the input directory. It could possibly overwrite input
files.
2. Configure the filters during verifying it on different images.
a) Open the image display to preview changes on-the-fly.
b) Configure the resizer during watching results directly.
c) Do also put e. g. the /Image/Transform/Cropping if you'd like.
d) Let these configuration windows opened.
e) Some files in the list appeared after directly after applying the step
1b. Press on an item in order to align settings (e. g. resizing) using
it.
3. Press "Run all" to process all images with the same reliable settings.
4. Save the project for future reuse.
Make image sensitive setting on some filters.
In some cases there are exceptions where some filters should be configured
differently but you want to save some reconfiguration effort during processing
though.
1. Load the project of the batch process.
2. Assume that you want to insert the /Image/Transform/Rotate (Flip) directly
after resizing.
a) Press on the input connector that follows the resizer to disconnect.
b) Connect the rotate (flip) filter between the disconnection to both
sides.
c) Create a new directory where image sensitive settings should be stored.
d) Go to the General settings tab of the rotate (flip) configuration.
e) Enter a file (not folder) path of the default configuration settings
and press on "Write" after generating settings that should be applied
by default. Non existing file will be created.
f) Configure the file sensitive settings path using the newly created
folder.
g) When you wish to store apply exceptional settings, press on write
below file sensitive settings.
Final usage hints:
* Make usage of file drop fields near open, save projects or input/output
files to simplify the user experience by a single step.
* The project saving feature is meant to save time if you want to re-edit
images though but retain a similar result.
* Watch your RAM (random access memory) of your PC. Every filter stores data
inside it. Handling too many large images may slow your computer or an SSD
may take damage faster when having pagefile or SWAP on it.
DEVELOPING
==========
This tool is still fairly light weight. The batch process and pipeline editor
features are designed by a flexible way so it is not limited to the purpose of
image editing. It can also deal with other simulation processes. E. g. you can
build a logic simulator by programming few other filter and data type classes.
The API is still quite simple.