Skip to content

Commit 7cf104c

Browse files
committed
docs: Update timelapse.md.
1 parent bd63350 commit 7cf104c

File tree

1 file changed

+8
-11
lines changed

1 file changed

+8
-11
lines changed

docs/timelapse.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,17 @@ The folder structure is created depending on what you fetch, and you can fetch f
1212

1313
All images in an image set will be used to build a timelapse. So for example, if you've collected an entire set of satellite images from the past 2 hours, and run the build timelapse command on that image set, your timelapse will be built of the files from those 2 hours. At the moment, **bomthegov** does not ignore any frames from a collected image set, so whatever images are in the 'images' folder for that ID, is what will be used to build your timelapse.
1414

15-
To see a list of available image sets that can be timelapsed, you can run:
15+
To begin the process of building a timelapse from a list of available images, you can run:
1616

1717
`bash bomthegov timelapse list`
1818

19-
If you know the ID of the image set you wish to timelapse right away, you can specify it, like so:
19+
That will show you a list of IDs that are ready to timelapse, and ask you questions about what maximum resolution and Frames Per Second (FPS) rate you want the video to be.
20+
21+
If you know the ID of the image set, and you wish to timelapse right away from the command line (with resolution and FPS defaults), you can specify the ID to process, like so:
2022

2123
`bash bomthegov timelapse IDR024`
2224

23-
and **bomthegov** will start building it immediately.
25+
and **bomthegov** will start building a timelapse for that ID immediately/uninteractively.
2426

2527

2628

@@ -30,7 +32,7 @@ and **bomthegov** will start building it immediately.
3032

3133
The conversion process is likely to be resource-intensive on RAM, CPU, and disk, and depending on how many images need to be converted to video frames, and their original resolution, building the timelapse video may take a long time.
3234

33-
Once a timelapse has been successfully created, **bomthegov** will notify you, and then move the collected image set to a folder called '.archive' so that your image collection for that same ID starts "fresh" for a new timelapse from now on. Your previously collected images are not deleted however, they're simply moved to the '.archive' folder inside 'images' where you can either use/merge them again later, or delete them manually if you choose.
35+
Once a timelapse has been successfully created, **bomthegov** will notify you, and then ask if you would like to remove the ID from the timelapse list/move the collected image set to a folder called '.archive' so that your image collection for that same ID starts "fresh" for a new timelapse. Your previously collected images are not deleted during this process, they're simply compressed into an archive file (TAR), and moved to the '.archive' folder inside 'images' where you can either use/merge them again later, or delete them manually if you choose.
3436

3537
You can explore the archived images sets yourself here:
3638

@@ -48,12 +50,7 @@ Previously prepared timelapse videos will not be deleted in a reset.
4850

4951
## Technical details
5052

51-
The "Frames Per Second" (FPS) for timelapse videos are currently set as follows:
52-
53-
* Radar images timelapse at 10fps,
54-
* Satellite images timelapse at 25fps.
55-
56-
These rates may change in future versions of **bomthegov**.
53+
The default maximum video resolution and Frames Per Second (FPS) for timelapse videos is 1920x1080 (full HD) at 25fps.
5754

58-
Timelapse videos export to MP4 video format, with default settings that should make them streamable on the web, and viewable on mobile devices.
55+
All timelapse videos export to MP4 video format, which should make them streamable on the web, and viewable on mobile devices.
5956

0 commit comments

Comments
 (0)